This API is in private preview. Target September 2026; timing is subject to change.
The values below illustrate the intended request shape.
{
"method": "subscribe",
"subscription": {
"type": "candles",
"coins": [
"BTC"
],
"intervals": [
"1m"
]
}
}{
"channel": "subscriptionResponse",
"data": {
"subscriptionId": "sub_01",
"type": "candles"
}
}{
"channel": "candles",
"subscriptionId": "sub_01",
"blockHeight": 123456,
"blockTime": 1780000000000,
"cursor": "<opaque cursor>",
"data": {
"coin": "BTC",
"interval": "1m",
"openTime": 1780000000000,
"closeTime": 1780000059999,
"open": "100000.0",
"high": "100010.0",
"low": "99990.0",
"close": "100005.0",
"volume": "12.4",
"isFinal": false
}
}| Field | Type | Description |
|---|---|---|
| coin | string | Market symbol for the candle. |
| interval | string | Candle interval. |
| openTime | integer | Start time of the candle interval, in milliseconds. |
| closeTime | integer | End time of the candle interval, in milliseconds. |
| open | string | Opening price for the candle interval. |
| high | string | Highest price during the candle interval. |
| low | string | Lowest price during the candle interval. |
| close | string | Closing price for the candle interval. |
| volume | string | Volume traded in the base asset during the candle interval. |
| isFinal | boolean | Finality indicator. |
{
"method": "unsubscribe",
"subscription": {
"type": "candles",
"coins": [
"BTC"
],
"intervals": [
"1m"
]
}
}To resume a stream, supply cursor in the subscription object. The cursor is opaque: clients store and return it unmodified, and its format may change.