Skip to main content
POST
crypto.exchange.candles

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
exchange
enum<string>
required

Exchange identifier. Example: bithumb.

Available options:
bithumb,
upbit,
hashkey,
bitflyer,
coinone,
korbit
pair
string
required

Trading pair in base/quote form, e.g. BTC/KRW. Example: BTC/KRW.

Required string length: 1 - 512
from
string

Start of time range. Accepts Unix seconds or date string. Example: 2026-06-24T09:00:00Z.

Required string length: 1 - 512
includeSynthetic
boolean

Whether to include carry-forward candles for no-trade intervals. Defaults to true for continuous charts; set false for raw exchange-only candles. Example: True. Defaults to true.

interval
enum<string>

Candle interval. Example: 5m. Defaults to "5m".

Available options:
5m,
4h,
1w
limit
number

How many to return, 1 to 20. Default 10.

Required range: x >= 1
to
string

End of time range. Accepts Unix seconds or date string. Example: 2026-06-24T10:00:00Z.

Required string length: 1 - 512

Response

The result

results
object[]
required

The matching items.

nextCursor
string

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