---
title: "Get Library Entry"
method: GET
path: "/v1/library/{slug}"
tags: ["library"]
---

# Get Library Entry

`GET /v1/library/{slug}`

## Request

- Base URL: `https://api.usekeel.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.usekeel.io/v1/library/{slug}`
- Auth: none declared

Detail facts for one entry: metrics, config schema, and public variants.

Package reads only by default. The BTC hold ``reference`` is opt-in
(``references=true``) — the same rule ``/v1/backtests/{id}/curve`` follows
(Q-1886): a hold line is asked for, never volunteered, and the package
stores no benchmark figure to show instead (Q-1901).

## Path parameters

- `slug` string, required

## Query parameters

- `references` boolean: Also compute the BTC hold reference over the entry's backtest window (one price read). Off by default: the entry detail reads the package only.

## Headers

- `Authorization` string, nullable
- `X-Org-Id` string, nullable

## Response `200`

Successful Response

- LibraryEntryDetail: Detail-view facts for the in-app compact library entry surface.
  - `slug` string, required
  - `name` string, required
  - `category` string, nullable
  - `risk_band` string, nullable
  - `public_path` string, nullable
  - `primary_keyword` string, nullable
  - `is_index_variant` boolean
  - `live_badge` boolean
  - `headline` object, nullable
  - `default_variant_id` string, nullable
  - `equity_curve` array[], nullable
    - unknown[]
      - unknown
  - `import_id` string, nullable
  - `entry_version` string, nullable
  - `data_as_of` string, nullable
  - `stale` boolean
  - `backtest_window` object, nullable
  - `trade_count_caveat` string, nullable
  - `variant_selection_rationale` string, nullable
  - `config_schema` object
  - `variants` LibraryVariantSummary[]
    - `variant_id` string, required
    - `label` string, nullable
    - `params` object
    - `metrics` object, nullable
    - `is_default` boolean
    - `publishable` boolean
    - `forkable` boolean
    - `failure_reason` string, nullable
    - `equity_curve` array[], nullable
      - unknown[]
        - unknown
  - `thesis` string, nullable
  - `summary` string, nullable
  - `coverage_kind` string, nullable
  - `coverage_note` string, nullable
  - `selected_knobs` object[]
  - `canonical_equity` array[], nullable
    - unknown[]
      - unknown
  - `source_hash` string, nullable
  - `canonical` object, nullable
  - `monthly_returns` object[], nullable
  - `regime_breakdown` object, nullable
  - `per_asset_stats` object[], nullable
  - `graph` object, nullable
  - `dsl` string, nullable
  - `reference` object, nullable
  - `basket_resolved_at` string, nullable
  - `delisted_members` object[]
  - `basket_note` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/usekeel/apis/keel-api.md) · [All operations](https://skmtc.dev/usekeel/apis/keel-api/llms.txt) · [OpenAPI document](https://skmtc.dev/usekeel/apis/keel-api/revisions/3191ca10b0ab?raw)