Sign in

v1

latestOpenAPI 3.0.2Apache 2.02026-07-17189642856.1 KB
Timeseries stream

Asset metrics

Returns a WebSocket stream of metrics for specified assets.<br/> Endpoint supports only block by block (1b frequency), per second (1s frequency), and sub-second (200ms frequency) metrics.<br/> Different sets of metrics may come in different messages.<br/> If you are falling behind (slow client) you will get warning message first, then error message and disconnection will happen.

get/timeseries-stream/asset-metrics

Query parameters

assetsstring[] required

Comma separated list of assets.<br/> Use a corresponding /catalog-all-v2/asset-{dataType} endpoint for the full list of supported assets for a given data type.

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:1s

Frequency of the metrics. Supported values are 1b (block by block), 1s, 200ms.

backfill'latest' | 'none'

What data should be sent upon a connection.<br/> By default the latest values are sent just before real-time data.

prettyboolean

Human-readable formatting of JSON responses.

ignore_unsupported_errorsboolean

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

ignore_forbidden_errorsboolean

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

Response

Asset metrics WebSocket message.

assetstring required

Name of the asset.

timestring required

The time in ISO 8601 date-time format. Always with nanoseconds precision.

cm_sequence_idstring required

The monotonically increasing message number, resets on disconnection.