Asset metrics

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

get

Authorizations

api_key

api_keystringRequired

Coin Metrics API key can be specified as ?api_key= query parameter.

Query parameters

assetsstring[]Required

Comma separated list of assets.
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.
Information on all available metrics can be found on page https://coverage.coinmetrics.io/asset-metrics-v2.
Use the /catalog-all-v2/asset-metrics endpoint for the full list of supported metrics per asset.

Example: ["AdrActCnt","BlkHgt"]

frequencystringOptional

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

Default: 1bExample: 1s

backfillstring · enumOptional

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

Default: latestPossible values:

prettybooleanOptional

Human-readable formatting of JSON responses.

Default: false

ignore_unsupported_errorsbooleanOptional

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

Default: false

ignore_forbidden_errorsbooleanOptional

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

Default: false

Responses

414

Provided URI is too long. It must not be greater than 10000 symbols.

No content

default

Asset metrics WebSocket message.

application/json

get/timeseries-stream/asset-metrics

JavaScriptPython

// This is getting Reference Rates for Bitcoin and Ethereum at a frequency of 1 second
ws = new WebSocket("wss://api.coinmetrics.io/v4/timeseries-stream/asset-metrics?assets=btc,eth&metrics=ReferenceRate&frequency=1s&pretty=true&api_key=<your_key>")
ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")

No content