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
string
required

Candle interval. Supported values: 1m, 5m, 15m, 1h, 4h, 1d.

before
string<date-time> | null

Return candles before this UTC timestamp. Omit to read from the current server time.

limit
integer<int64> | null

Number of candles to return. Defaults to 100 and is capped by the API.

Response

OHLCV candles

data
object
required

OHLCV candle series for a trading pair and interval.

status
enum<string>
required
Available options:
success