Skip to main content
GET
Get candles

Authorizations

X-Api-Key
string
header
default:sb_test_your_key
required

API credential. Withdrawal quote and submit operations additionally require the documented Ed25519 timestamp, nonce, and signature headers.

Query Parameters

pair_id
string
required

Trading pair identifier returned by GET /partner/exchange/markets, for example USD/NGN.

interval
enum<string>
required

Width of one candle. Supported values: 1m, 5m, 15m, 1h, 4h, 1d. This is independent of the chart's visible time range. Supported duration of one OHLCV candle.

Available options:
1m,
5m,
15m,
1h,
4h,
1d
from
string<date-time>
required

Inclusive RFC 3339 UTC start boundary. It is required and must align exactly to the selected candle interval.

to
string<date-time>
required

Exclusive RFC 3339 UTC end boundary. It is required and must align exactly to the selected candle interval. There is no bucket-count limit; the requested window is never clipped.

Response

OHLCV candles

data
object
required

Non-empty OHLCV candles for an exact bounded UTC window, including its calculation timestamp.

status
enum<string>
required
Available options:
success