CoinMetricsClient.get_index_levels

coinmetrics.api_client.CoinMetricsClient.get_index_levels(
    indexes,
    frequency=None,
    granularity=None,
    start_time=None,
    end_time=None,
    start_inclusive=None,
    end_inclusive=None,
    timezone=None,
    page_size=None,
    paging_from='start',
    limit_per_index=None,
    include_verification=None,
    format='json_stream',
)

Returns index levels for specified indexes and date range.

• Parameters:

  • indexes (list (str ) , str) -- list of index names, e.g. 'CMBI10'

  • frequency (str) -- frequency of the returned timeseries, e.g 15s, 1d, etc.

  • granularity (str) -- Default: "1s" granularity of the returned timeseries, e.g 1s, 1m, etc.

  • start_time (datetime , date , str) -- Start time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120

  • end_time (datetime , date , str) -- End time of the timeseries (string or datetime). Datetime object may be timezone naive or aware. Multiple formats of ISO 8601 are supported: 2006-01-20T00:00:00Z, 2006-01-20T00:00:00.000Z, 2006-01-20T00:00:00.123456Z, 2006-01-20T00:00:00.123456789, 2006-01-20, 20060120

  • start_inclusive (bool) -- Flag to define if start timestamp must be included in the timeseries if present. True by default.

  • end_inclusive (bool) -- Flag to define if end timestamp must be included in the timeseries if present. True by default.

  • timezone (str) -- timezone of the start/end times in db format for example: "America/Chicago". Default value is "UTC". For more details check out API documentation page.

  • page_size (int) -- number of items returned per page when calling the API. If the request times out, try using a smaller number.

  • paging_from (PagingFrom , str) -- Defines where you want to start receiving items from, 'start' or 'end' of the timeseries.

  • limit_per_index (int) -- How many entries per index the result should contain.

  • include_verification (bool | None) -- Default: False set to true, includes information about verification.

  • format (str) -- 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'.

• Type: bool

Returns:

• DataCollection

  • Index Levels timeseries.