Skip to main content
GET
/
partner
/
exchange
/
orderbook
/
{pair_id}
/
snapshot
Get order book snapshot
curl --request GET \
  --url https://api.stabyl.com/v1/partner/exchange/orderbook/{pair_id}/snapshot \
  --header 'X-Api-Key: <api-key>'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://stabyl.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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

Order book snapshot

​
data
object
required

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

​
status
enum<string>
required
Available options:
success