Index levels

Returns a stream of levels for specified indexes. If you are falling behind (slow client) you will get warning message first, then error message and disconnect will happen.

get

Authorizations

api_key

api_keystringRequired

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

Query parameters

indexesstring[]Required

Comma separated list of indexes.
Use the /catalog-all-v2/index-levels endpoint for the full list of supported indexes.

Example: CMBIBE

include_verificationbooleanOptional

If set to true, includes information about verification.

Default: false

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

Responses

200

Index levels WebSocket message.

application/json

Information about index level.

indexstringRequired

Name of the index.

timestring · date-timeRequired

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

levelstring · decimalRequired

The value of the index.

cm_sequence_idstringRequired

The monotonically increasing message number, resets on disconnection.

401

Requested resource requires authorization.

application/json

403

Requested resource is not available with supplied credentials.

application/json

414

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

get/timeseries-stream/index-levels

JavaScriptPython

// Streams the levels for CMBIBTC index
ws = new WebSocket("wss://api.coinmetrics.io/v4/timeseries-stream/index-levels?indexes=CMBIBTC&pretty=true&api_key=<your_key>")
ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")

{
  "index": "CMBIWORK",
  "level": 389473805.7138389,
  "time": "2017-05-22T00:00:00.000000000Z",
  "cm_sequence_id": 0
}