Order book depth
get_orderbookRead-only
Depth as [price_cents, quantity] bid pairs per side plus best bid and ask; contracts adds walk, that size's cost through the book. Paper fills take the whole size at one price.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ref | No | The same as ticker. | |
| depth | No | Levels per side. Default 5. | |
| ticker | No | A Kalshi ticker, instrument id or slug. ref is the same. | |
| contracts | No | Size to walk the book for (walk.yes, walk.no). |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| orderbook | No |