Get order book snapshot

Returns bid and ask depth for one market, including a sequence value and timestamp. Treat the response as a point-in-time snapshot and refresh before submitting price-sensitive orders.

GET /partner/exchange/orderbook/{pair_id}/snapshot

Get order book snapshot

cURL

curl --request GET \
  --url https://api.stabyl.com/v1/partner/exchange/orderbook/{pair_id}/snapshot \
  --header 'X-Api-Key: <api-key>'

200

{
  "data": {
    "asks": [
      {
        "price": "1660.00",
        "quantity": "75.00"
      }
    ],
    "bids": [
      {
        "price": "1650.00",
        "quantity": "100.00"
      }
    ],
    "pair_id": "USD/NGN",
    "sequence": 12345,
    "timestamp": "2026-05-24T12:00:00Z"
  },
  "status": "success"
}

Authorizations

X-Api-Key · string · header · default: sb_test_your_key · required

API key. Send it in the X-Api-Key header.

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

200

application/json

Order book snapshot

data · object · required

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

Show child attributes

status · enum<string> · required

Available options: success