v1

latestOpenAPI 3.0.2Apache 2.02026-07-17189642856.1 KB
Timeseries stream

Market candles

Returns a stream of candles 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-candles

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.

frequencystring
Example:1m

Candle duration. Supported values are 1m, 5m, 10m, 15m, 30m, 1h, 4h, 1d.

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

Candle WebSocket message.

marketstring required

Unique name of the market.

timestring required

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

price_openstring required

The opening price of the candle.

price_closestring required

The closing price of the candle.

price_highstring required

The high price of the candle.

price_lowstring required

The low price of the candle.

vwapstring required

The volume-weighted average price of the candle.

volumestring required

The volume of the candle in units of the base asset.

candle_usd_volumestring required

The volume of the candle in USD.

candle_trades_countstring required

The number of trades used for candle calculation.

cm_sequence_idstring required

The monotonically increasing message number, resets on disconnection.