Skip to main content
GET
Get candles

Path Parameters

instrumentId
string<decimal>
required

Instrument ID to fetch candles for. An instrument identifier (8-byte hash).

Example:

"42"

interval
enum<string>
required

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"

startTime
null | integer<int64>
required

Start timestamp in milliseconds (optional, defaults to 24h ago).

Required range: x >= 0
endTime
null | integer<int64>
required

End timestamp in milliseconds (optional, defaults to now).

Required range: x >= 0
limit
integer | null
default:500
required

Maximum number of candles to return (optional, defaults to 500, max 1000).

Required range: x >= 0

Response

Candles

candles
object[]
required

OHLCV candles for the requested time range.