HTTP endpoints
Get candles
OHLCV candles for an instrument over a time range.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| instrumentId | yes | string (decimal) | Instrument ID to fetch candles for. |
| interval | yes | string | Candle timeframe (1m, 5m, 15m, 30m, 1h, 4h, 1d). |
| startTime | yes | integer (int64) | Start timestamp in milliseconds (optional, defaults to 24h ago). |
| endTime | yes | integer (int64) | End timestamp in milliseconds (optional, defaults to now). |
| limit | yes | integer | null |
Response fields
| Parameter | Required | Type | Description |
|---|---|---|---|
candles | yes | object[] | OHLCV candles for the requested time range. |
candles[].close | yes | number (float) | — |
candles[].high | yes | number (float) | — |
candles[].low | yes | number (float) | — |
candles[].open | yes | number (float) | — |
candles[].slot | yes | integer (int64) | — |
candles[].timestamp | yes | integer (int64) | — |
candles[].volume | yes | number (float) | — |
Response example
A sample 200 response body is attached to this operation as an OpenAPI example — see the Example panel on this page.
GET
Get candles
Path Parameters
Instrument ID to fetch candles for. An instrument identifier (8-byte hash).
Example:
"42"
Candle timeframe (1m, 5m, 15m, 30m, 1h, 4h, 1d). Candle timeframe/interval for aggregation
Available options:
1m, 5m, 15m, 30m, 1h, 4h, 1d Example:
"1h"
Start timestamp in milliseconds (optional, defaults to 24h ago).
Required range:
x >= 0End timestamp in milliseconds (optional, defaults to now).
Required range:
x >= 0Maximum number of candles to return (optional, defaults to 500, max 1000).
Required range:
x >= 0Response
Candles
OHLCV candles for the requested time range.
Get candles