GET
Get market candles

Path Parameters

marketId
string
required
Minimum string length: 1

Query Parameters

series
enum<string>
default:index

Candle source series. Defaults to index. series=mark is declared but not served yet: HTTP 400 operation_not_available, retryable=false.

Available options:
trade,
index,
mark
tf
enum<string>
default:1m

Candle timeframe. Defaults to 1m.

Available options:
1m,
3m,
5m,
15m,
30m,
1h,
2h,
4h,
8h,
12h,
1d,
3d,
1w,
1M
from
string

Optional inclusive epoch-millisecond start of [from, to); align to the timeframe boundary.

to
string

Optional exclusive epoch-millisecond end of [from, to); align to the timeframe boundary.

Response

Success

version
string
required
Allowed value: "external-candles/v1"
marketId
string
required
Minimum string length: 1
series
enum<string>
required
Available options:
trade,
index,
mark
timeframe
enum<string>
required
Available options:
1m,
3m,
5m,
15m,
30m,
1h,
2h,
4h,
8h,
12h,
1d,
3d,
1w,
1M
fromEpochMs
integer
required
Required range: x >= 0
toEpochMs
integer
required
Required range: x >= 0
snapshotSequence
integer
required
Required range: x >= 0
candles
object[]
required
gaps
object[]
required
resync
object
required