CoinMetricsClient.get_market_candles

coinmetrics.api_client.CoinMetricsClient.get_market_candles(
    markets,
    frequency=None,
    page_size=None,
    paging_from='start',
    start_time=None,
    end_time=None,
    start_inclusive=None,
    end_inclusive=None,
    timezone=None,
    limit_per_market=None,
    format='json_stream',
    ignore_unsupported_errors=None,
    ignore_forbidden_errors=None,
)

Returns market candles for specified markets, frequency and date range. For more information on market candles, see: https://docs.coinmetrics.io/info/markets/candles

• Parameters:

  • markets (list (str ) , str) -- list of market ids. Market ids use the following naming convention: exchangeName-baseAsset-quoteAsset-spot for spot markets, exchangeName-futuresSymbol-future for futures markets, and exchangeName-optionsSymbol-option for options markets. e.g., 'coinbase-btc-usd-spot', 'bitmex-XBTUSD-future'

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

  • 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.

  • 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.

  • limit_per_market (int) -- How many entries per market the result should contain.

  • 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'.

  • ignore_unsupported_errors (bool) -- Whether to ignore 401 Unauthorized errors. Default is False.

  • ignore_forbidden_errors (bool) -- Whether to ignore 403 Forbidden errors. Default is False.

Returns:

• DataCollection

  • Market Candles timeseries.