v1

latestOpenAPI 3.0.2Apache 2.02026-07-17189642856.1 KB
Timeseries

Exchange-asset metrics

Returns metrics for specified exchange-asset.<br/> Results are ordered by tuple (exchange_asset, time).<br/> To fetch the next page of results use next_page_url JSON response field.<br/>

get/timeseries/exchange-asset-metrics

Query parameters

exchange_assetsstring[] required

Comma separated list of exchange-asset pairs or patterns like exchange-* or *-asset.

metricsstring[] required

Comma separated metrics to request time series data for.<br/> Information on all available metrics can be found on page https://coverage.coinmetrics.io/exchange-asset-metrics-v2.<br/> Use the /catalog-all-v2/exchange-asset-metrics endpoint for the full list of supported metrics per exchange-asset combination.

[
  "open_interest_reported_future_usd",
  "volume_reported_spot_usd_1d"
]
frequencystring

Frequency of the exchange-asset metrics. Supported values are 5m, 1h, 1d.

start_timestring

Start of the time interval.<br/> This field refers to the time field in the response.<br/> 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.123456789Z, 2006-01-20, 20060120.<br/> Inclusive by default.<br/> UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.<br/> If start_time is omitted, response will include time series from the earliest time available.

end_timestring

End of the time interval.<br/> This field refers to the time field in the response.<br/> 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.123456789Z, 2006-01-20, 20060120.<br/> Inclusive by default.<br/> UTC timezone by default. Z suffix is optional and timezone parameter has a priority over it.<br/> If end_time is omitted, response will include time series up to the latest time available.

start_inclusiveboolean

Inclusive or exclusive corresponding start_* parameters.

end_inclusiveboolean

Inclusive or exclusive corresponding end_* parameters.

timezonestring
Example:America/New_York

Timezone name for start_time and end_time timestamps.<br/> This parameter does not modify the output times, which are always UTC.<br/> Format is defined by TZ database.

page_sizeinteger

Number of items per single page of results.<br/> The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

paging_from'start' | 'end' PagingFrom

Where does the first page start, at the start of the interval or at the end.<br/> The value of this parameter is ignored if the endpoint supports the format parameter and its value is set to json_stream.

sort'exchange_asset' | 'time'

How results will be sorted. Metrics are sorted by (exchange_asset, time) by default. If you want to sort 1d metrics by (time, exchange_asset) you should choose time as value for the sort parameter.<br/> Sorting by time is useful if you request metrics for a set of exchange-assets.

limit_per_exchange_assetinteger

How many entries per exchange_asset result should contain. For example, this combination of parameters exchange_assets=binance-btc,coinbase-eth&metrics=volume_trusted_spot_usd_1h&limit_per_exchange_asset=1 returns the latest volume_trusted_spot_usd_1h values for binance-btc and coinbase-eth.

prettyboolean

Human-readable formatting of JSON responses.

format'json' | 'json_stream' | 'csv'

Format of the response. Supported values are json, json_stream, csv.

next_page_tokenstring

Token for receiving the results from the next page of a query.<br/> Should not be used directly. To iterate through pages just use next_page_url response field.

Response

Time series of exchange-asset metrics.

next_page_tokenstring

Token of the next page results for a given request.

next_page_urlstring

URL of the next page results for a given request.