Order book depth
get_order_bookRead-onlyIdempotent
Order book for a DeepBook pool: top N price levels per side and cumulative liquidity (base qty and quote notional) within ±X% of mid. Education/information only; not financial advice. Read-only public data, may be delayed or wrong. Free: 100 calls/day per client, then 0.002 USDC per call on Sui mainnet, prepaid in batches of about 0.01 USDC (the payment-required response gives an exact amount and a payment_token).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pool | Yes | DeepBook pool name BASE_QUOTE, e.g. SUI_USDC (case-insensitive; '/' or '-' also accepted) | |
| levels | No | Price levels to return per side (1-100, default 10) | |
| payment_tx | No | Only after the free tier: Sui transaction digest of your exact USDC payment for payment_token (see the payment-required response) | |
| within_pct | No | Depth bands as % distance from mid, e.g. [0.5, 1, 2] | |
| payment_token | No | Only after the free tier: the private payment_token from the payment-required response; it holds your prepaid calls |