Market contract prices

Returns a WebSocket stream of contract prices for specified markets. This includes index price and mark price that are used by the exchange for settlement and risk management purposes. If you are falling behind (slow client) you will get warning message first, then error message and disconnection will happen.

get

Authorizations

api_keystringRequired

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

Query parameters

marketsstring[]Required

Comma separated list of markets or market patterns like exchange-* or exchange-*-spot or *USDT-future.
Use a corresponding /catalog-all-v2/market-{dataType} endpoint for the full list of supported markets for a given data type.

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

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.

default

Contract prices WebSocket message.

application/json

get/timeseries-stream/market-contract-prices

ws = new WebSocket("wss://api.coinmetrics.io/v4/timeseries-stream/market-contract-prices?markets=deribit-BTC-*-option&pretty=true&api_key=<your_key>")
ws.onmessage = m => console.log(m.data); ws.onclose = () => console.log("closed")

{
  "error": {
    "type": "unauthorized",
    "message": "Requested resource requires authorization."
  }
}