v1

latestOpenAPI 3.0.2Apache 2.02026-07-17189642856.1 KB

Timeseries stream

Market open interest

Returns a WebSocket stream of open interests for specified markets.<br/> If you are falling behind (slow client) you will get warning message first, then error message and disconnection will happen.

get/timeseries-stream/market-openinterest

Query parameters

marketsstring[] required

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

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.

Response

Open Interest WebSocket message.

marketstring required

Unique name of the market.

timestring required

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

contract_countstring required

Number of contracts.

value_usdstring required

Contract value in USD.

exchange_timestring

Time corresponding to open interest data point, according to the exchange. Can be NULL, if exchange doesn't support it.

cm_sequence_idstring required

The monotonically increasing message number, resets on disconnection.