v1

latestOpenAPI 3.0.2Apache 2.02026-07-17189642856.1 KB
Timeseries

Asset metrics

Returns requested metrics for specified assets.<br/><br/> Results for block by block metrics (1b frequency) are ordered by tuple (asset, height, block_hash), all other metrics are ordered by tuple (asset, time). You can change the sorting using sort query parameter.<br/><br/> Supported output formats are json (default), json_stream and csv. Use the format query parameter to override it.<br/> To fetch the next page of results use next_page_url JSON response field or x-next-page-url CSV HTTP header if present.<br/><br/> If multiple metrics are requested in the same time the strict policy for partially available metrics among requested ones is applied: <ul>

<li>missing metric name in the JSON response means that the metric is "not a supported metric" for the asset and frequency while some other requested metrics are supported.</li> <li>`null` value of the metric means "no data in the database" while some other requested metrics have data.</li> </ul>
get/timeseries/asset-metrics

Query parameters

assetsstring[] required

Comma separated list of assets.<br/> Use the /catalog-all-v2/asset-metrics endpoint for the full list of supported assets or specify asterisk (*) in order to get metrics for all supported assets.

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/asset-metrics-v2.<br/> Use the /catalog-all-v2/asset-metrics endpoint for the full list of supported metrics per asset.

[
  "AdrActCnt",
  "BlkHgt"
]
frequencystring
Example:1b

Frequency of the metrics. Supported values are 1b (block by block), 1s (one second), 1m (one minute), 5m (five minutes), 10m (ten minutes), 1h (one hour), 1d (one day), 1d-ny-close (one day at New York close time). Please refer to the /catalog-v2/asset-metrics endpoint for the full list.<br/> Use the /catalog-all-v2/asset-metrics endpoint for the full list of supported frequencies per asset-metric pair.

status'all' | 'flash' | 'reviewed' | 'revised'

Which metric values do you want to see. Applicable only for "reviewable" metrics. You can find them in the /catalog-v2/asset-metrics endpoint.

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. Mutually exclusive with start_height and start_hash.<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. Mutually exclusive with end_height and end_hash.<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_heightinteger

The start height indicates the beginning block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with start_time and start_hash.

end_heightinteger

The end height indicates the ending block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with end_time and end_hash.<br/> This parameter is disabled for Community users.

start_hashstring

The start hash indicates the beginning block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with start_time and start_height.

end_hashstring

The end hash indicates the ending block height for the set of data that are returned.<br/> Inclusive by default. Mutually exclusive with end_time and end_height.

start_inclusiveboolean

Inclusive or exclusive corresponding start_* parameters.

end_inclusiveboolean

Inclusive or exclusive corresponding end_* parameters.

min_confirmationsinteger

Specifies how many blocks behind the chain tip block by block metrics (1b frequency) are based on. Default for btc is 2 and 99 for eth. For example, a min_confirmations of 0 means metrics are being calculated for the block at the tip of the chain (the latest block received by our node) whereas a min_confirmations of 6 means that metrics are being applied to the block that is 6 blocks behind the chain tip (i.e., the 7th block if the chain tip is block 1).

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'asset' | 'height' | 'time'

How results will be sorted. Metrics with 1b frequency are sorted by (asset, height, block_hash) tuples by default. Metrics with other frequencies are sorted by (asset, time) by default. If you want to sort 1d metrics by (time, 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 assets.

limit_per_assetinteger

How many entries per asset result should contain. For example, this combination of parameters assets=btc,eth&metrics=ReferenceRate&limit_per_asset=1 returns the latest ReferenceRate values for btc and eth.

prettyboolean

Human-readable formatting of JSON responses.

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

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

null_as_zeroboolean

Nulls are represented as zeros in the response.

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.

ignore_forbidden_errorsboolean

Ignore "forbidden" errors for the items you currently don't have access to.

ignore_unsupported_errorsboolean

Ignore "unsupported" errors for not currently supported by Coin Metrics items.

Response

Time series of metrics for an asset.

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.