Skip to main content

CoinMetricsClient.get_protocol_metrics

coinmetrics.api_client.CoinMetricsClient.get_protocol_metrics(
    protocols,
    metrics,
    frequency,
    chains=None,
    markets=None,
    page_size=None,
    paging_from='start',
    start_time=None,
    end_time=None,
    start_inclusive=None,
    end_inclusive=None,
    timezone=None,
    next_page_token=None,
    format=None,
)

Returns metrics for specified protocols. Results are ordered by tuple (protocol, market).

  • Parameters:
    • protocols (list (str ) , str) -- Comma separated list of protocols like 'aave_v3' or 'morpho_blue'.
    • metrics (list (str ) , str) -- list of protocol-specific metric names, e.g. 'supply_apy'
    • frequency (str) -- frequency of the returned timeseries. Supported values are '1d', '1m'.
    • chains (list (str ) , str) -- Comma separated list of protocol chains like 'ethereum' or 'base'.
    • markets (list (str ) , str) -- Comma separated list of protocol markets like 'core-weth' or 'steakusdc'.
    • 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.
    • next_page_token (str) -- 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 (str) -- Format of the response. Supported values are json, json_stream. Default is json.

Returns: