Combined order book
orderbookThe order book for one pair merged across the streamed venues and aggregated by exact price: best bid and ask, the spread, and the dollars resting on each side in the top levels, with the venues holding each level. Use it for "where are the walls on BTC", "how deep is the bid", "what is the spread". Keyless reaches the free pairs at 5 levels; Starter any pair at 10; Pro 25. Descriptive market data only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| coin | No | Alias for pair. | |
| pair | No | Trading pair, for example ETH/USD. A bare symbol like ETH is read as ETH/USD. Defaults to BTC/USD when omitted. | |
| levels | No | Price levels per side. Defaults to 10; the ceiling is 5 on the free plans, 10 on Starter, 25 on Pro (hard). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| levels | No | Levels per side returned. | |
| summary | No | The answer in one plain sentence, computed from the fields below. Open the reply with this, then let the numbers back it up. Null only when there was nothing to summarise. | |
| best_ask | No | Best ask across venues. | |
| best_bid | No | Best bid across venues. | |
| combined | No | bids and asks aggregated by price, each level listing the venues holding it. | |
| available | No | False when the pair is not covered, not in the free set on this plan, or has no snapshot. | |
| spread_pct | No | Spread as a percent of the ask. | |
| per_exchange | No | Each venue's own top levels. | |
| exchange_count | No | Venues merged. | |
| ask_usd_in_levels | No | Dollars resting on the ask side in the returned levels. | |
| bid_usd_in_levels | No | Dollars resting on the bid side in the returned levels. |