Get order book levels

Returns aggregated bid or ask levels for one market. Use this endpoint for focused depth checks when you only need one side of the book.

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

Get order book levels

cURL

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

200

{
  "data": {
    "levels": [
      {
        "price": "1650.00",
        "quantity": "100.00"
      }
    ],
    "pair_id": "USD/NGN",
    "side": "bid",
    "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

side · string · required

Order book side. Use bid for buys or ask for sells.

limit · integer<int64> | null

Maximum number of price levels to return.

Response

200

application/json

Order book levels

data · object · required

Aggregated order book levels for one side of a trading pair.

Show child attributes

status · enum<string> · required

Available options: success