Skip to main content
GET
Get order book snapshot

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.

Path Parameters

pair_id
string
required

Trading pair identifier returned by GET /partner/exchange/markets. URL-encode / as %2F in path parameters, for example USD%2FNGN.

Query Parameters

levels
integer<int64> | null

Maximum number of bid and ask levels to return per side.

Response

Order book snapshot

data
object
required

Point-in-time bid and ask depth for a trading pair.

status
enum<string>
required
Available options:
success