---
title: "Supported index candles"
method: GET
path: "/catalog-all-v2/index-candles"
tags: ["Full catalog v2"]
---

# Supported index candles

`GET /catalog-all-v2/index-candles`

## Request

- Base URL: `https://api.coinmetrics.io/v4`
- URL: `https://api.coinmetrics.io/v4/catalog-all-v2/index-candles`
- Auth: API key in query parameter `api_key`
- TypeScript: <https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4/docs/catalog-all-v2/index-candles/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of all supported index candles along with the time ranges of available data per candle duration.

## Query parameters

- `indexes` string[]
- `page_size` integer
- `paging_from` 'start' | 'end', PagingFrom
- `next_page_token` string
- `format` string
- `pretty` boolean

## Response `200`

List of index candles statistics.

- CatalogV2IndexCandlesResponse
  - `data` CatalogIndexCandlesInfo[], required
    - `index` string, required: Name of the index.
    - `frequencies` CatalogCandleFrequency[]: Frequencies of the candle.
      - `frequency` string, required: Frequency of the candle.
      - `min_time` string, required: Minimal available time for time series.
      - `max_time` string, required: Maximal available time for time series.
  - `next_page_token` string: Token of the next page results for a given request.
  - `next_page_url` string: URL of the next page results for a given request.

## Other responses

- `400`: Index not found.
- `401`: Requested resource requires authorization.
- `414`: Provided URI is too long. It must not be greater than 10000 symbols.

---

[API](https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4.md) - [All operations](https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4/llms.txt) - [OpenAPI document](https://skmtc.dev/coinmetrics/apis/coin-metrics-api-v4/revisions/774268c0a4fe?raw)