marketdata

Current candles

Public current-candle updates for one timeframe and spot symbol. JSON uses decimal strings; Protobuf uses scaled integers.

Transport

WebSocket

Encoding

JSON Protobuf

Visibility

Public stream

Channel

public:spot:market:candles:{timeframe}:{symbolId}

Subscribe frame

{
  "type": "subscribe",
  "channel": "public:spot:market:candles:1m:1"
}

Channel parameters

timeframe string

Candle interval: 1s, 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, or 1mo. Buckets are UTC: up to 1d they start on whole multiples of their length since midnight, 3d buckets start every third day from 1970-01-01, 1w buckets start on Monday, and 1mo buckets start on the first day of the month.

e.g. 1m

symbolId integer

Numeric spot market symbol identifier.

e.g. 1

Message

Payload JSON object

close string

Latest or closing price in quote-asset units as a decimal string with up to nine fractional digits.

Example 101.7

high string

Highest price in the bucket, including the open, in quote-asset units as a decimal string with up to nine fractional digits.

Example 101.9

isClosed boolean

True only for the terminal update emitted after the bucket closes; false for updates to the current open bucket.

Example false

low string

Lowest price in the bucket, including the open, in quote-asset units as a decimal string with up to nine fractional digits.

Example 101.1

open string

Opening price in quote-asset units as a decimal string with up to nine fractional digits: the previous candle's close, or the first trade for a market's first candle.

Example 101.25

tsSec string

Candle bucket start time in Unix seconds (UTC), encoded as an exact decimal string.

Example 1767225600

volume string

Traded base-asset quantity in the bucket as a decimal string with up to 18 fractional digits.

Example 1.5