Skip to main content
POST
List candles

Body

application/json
venueId
string
required
priceKind
enum<string>
required

What the venue reports a price to be. Kinds are never relabelled or derived from one another.

Available options:
Traded,
Mark,
Index
interval
enum<string>
required

Candle length. Candles are aligned to whole multiples of it from the Unix epoch, in UTC.

Available options:
Minute1,
Minute3,
Minute5,
Minute15,
Minute30,
Hour1,
Hour2,
Hour4,
Hour6,
Hour12,
Day1
query
object
required
cursor
string | null

nextCursor from the previous page; omit for the first page. Only valid with the same query: same variant and filters.

Response

Successful result

One page of results; the server sets the page size. Send nextCursor as cursor for the next page. Pages are read live, so items can change while you page.

items
object[]
required
nextCursor
string | null
required

Pass as cursor to get the next page; null on the last page.