CoinMetricsClient.catalog_index_candles_v2

coinmetrics.api_client.CoinMetricsClient.catalog_index_candles_v2(
    indexes=None,
    page_size=None,
    paging_from=None,
    next_page_token=None,
    format='json_stream',
)

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

  • Parameters:

    • indexes (Optional *[*Union [strarrow-up-right , List [strarrow-up-right ] ] ]) -- Comma separated list of indexes. By default all assets are returned.

    • page_size (Optional [intarrow-up-right ]) -- Number of items per single page of results.

    • paging_from (Optional [strarrow-up-right ]) -- Where does the first page start, at the start of the interval or at the end.

    • next_page_token (Optional [strarrow-up-right ]) -- 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.

    • format (Optional [strarrow-up-right ]) -- Format of the response. Supported values are json, json_stream, csv. Default is json_stream. Setting format='json_stream' is generally more performant. page_size and paging_from is ignored when format='json_stream'.

Returns:

  • CatalogV2DataCollection

    • List of index candles statistics.

Last updated

Was this helpful?