> For the complete documentation index, see [llms.txt](https://gitbook-docs.coinmetrics.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook-docs.coinmetrics.io/cm-api-spec/meta-data/reference-data/indexes.md).
# Indexes
Returns a list of indexes metadata.
```json
{"openapi":"3.0.2","info":{"title":"Coin Metrics API v4","version":"4.0.0"},"tags":[{"name":"Reference Data","description":"Metadata information of entities supported by Coin Metrics.\n\n**Endpoints on this page:**\n- `GET /reference-data/asset-metrics` — Asset metrics\n- `GET /reference-data/assets` — Assets\n- `GET /reference-data/exchange-asset-metrics` — Exchange asset metrics\n- `GET /reference-data/exchange-metrics` — Exchange metrics\n- `GET /reference-data/exchange-pair-metrics` — Exchange pair metrics\n- `GET /reference-data/exchanges` — Exchanges\n- `GET /reference-data/indexes` — Indexes\n- `GET /reference-data/institution-metrics` — Institution metrics\n- `GET /reference-data/market-metrics` — Market metrics\n- `GET /reference-data/markets` — Markets\n- `GET /reference-data/pair-metrics` — Pair metrics\n- `GET /reference-data/pairs` — Pairs\n- `GET /reference-data/protocols` — Protocols"}],"servers":[{"url":"https://api.coinmetrics.io/v4"},{"url":"wss://api.coinmetrics.io/v4"},{"url":"https://community-api.coinmetrics.io/v4"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"description":"Coin Metrics API key can be specified as `?api_key=` query parameter.","in":"query","name":"api_key","type":"apiKey"}},"parameters":{"CatalogIndexId":{"description":"Comma separated list of indexes. By default all indexes are returned.","in":"query","name":"indexes","schema":{"type":"array","items":{"type":"string"}},"explode":false},"PageSize":{"description":"Number of items per single page of results.
The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.","in":"query","name":"page_size","schema":{"default":100,"type":"integer","format":"int32","minimum":1,"maximum":10000}},"PagingFromWithStartByDefault":{"description":"Where does the first page start, at the start of the interval or at the end.
The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.","in":"query","name":"paging_from","schema":{"default":"start","enum":["start","end"],"type":"string","format":"PagingFrom"}},"NextPageToken":{"description":"Token for receiving the results from the next page of a query.
Should not be used directly. To iterate through pages just use `next_page_url` response field.","in":"query","name":"next_page_token","schema":{"type":"string"}},"CatalogResponseFormat":{"description":"Format of the response. Supported values are `json`, `json_stream`.","in":"query","name":"format","schema":{"type":"string","default":"json"}},"Pretty":{"description":"Human-readable formatting of JSON responses.","in":"query","name":"pretty","schema":{"type":"boolean","default":false}}},"responses":{"ReferenceDataIndexes":{"description":"List of indexes metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceDataIndexesResponse"}}}},"IndexNotFound":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Index not found."},"Unauthorized":{"description":"Requested resource requires authorization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"UriTooLong":{"description":"Provided URI is too long. It must not be greater than 10000 symbols."}},"schemas":{"ReferenceDataIndexesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ReferenceDataIndexInfo"},"type":"array"},"next_page_token":{"$ref":"#/components/schemas/NextPageToken"},"next_page_url":{"$ref":"#/components/schemas/NextPageUrl"}},"required":["data"],"type":"object"},"ReferenceDataIndexInfo":{"description":"Index metadata.","properties":{"index":{"$ref":"#/components/schemas/Index"},"full_name":{"$ref":"#/components/schemas/FullName"},"description":{"$ref":"#/components/schemas/Description"},"type":{"$ref":"#/components/schemas/IndexType"}},"required":["index","full_name"],"type":"object"},"Index":{"description":"Name of the index.","type":"string"},"FullName":{"description":"Human-friendly name.","type":"string"},"Description":{"description":"Human-friendly description.","type":"string"},"IndexType":{"description":"Type of the index.","type":"string"},"NextPageToken":{"description":"Token of the next page results for a given request.","type":"string"},"NextPageUrl":{"description":"URL of the next page results for a given request.","type":"string"},"ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/ErrorObject"}},"required":["error"],"type":"object"},"ErrorObject":{"properties":{"type":{"description":"Error type string. Can be used for error identification.","type":"string"},"message":{"description":"Human-friendly error description. Can be amended without prior notification. Do not use for error identification in your code.","type":"string"}},"required":["type","description"],"type":"object"}}},"paths":{"/reference-data/indexes":{"get":{"summary":"Indexes","description":"Returns a list of indexes metadata.","operationId":"getReferenceDataIndexes","tags":["Reference Data"],"parameters":[{"$ref":"#/components/parameters/CatalogIndexId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PagingFromWithStartByDefault"},{"$ref":"#/components/parameters/NextPageToken"},{"$ref":"#/components/parameters/CatalogResponseFormat"},{"$ref":"#/components/parameters/Pretty"}],"responses":{"200":{"$ref":"#/components/responses/ReferenceDataIndexes"},"400":{"$ref":"#/components/responses/IndexNotFound"},"401":{"$ref":"#/components/responses/Unauthorized"},"414":{"$ref":"#/components/responses/UriTooLong"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://gitbook-docs.coinmetrics.io/cm-api-spec/meta-data/reference-data/indexes.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.