Orderbook
Orderbook Channels
Real-time order lifecycle events — placements, cancellations, fills, and state changes. Subscribe to track specific instruments, filter by direction, or monitor all orders for a maker address.
| Channel | Subscription scope | Guide |
|---|---|---|
orderbook_perps | By instrument or pair | Orderbook Perps |
orderbook_options | By instrument, pair, maturity, strike, type | Orderbook Options |
orderbook_maker | By maker address (both perps + options) | Orderbook Maker |
All three channels share the same event types and schemas — see Orderbook Events for the full field reference.
Event types
| Event | When |
|---|---|
post_order | New limit order enters the book |
cancel_order | Order cancelled (user, expiry, or system) |
update_order | Partial fill updates filled_amount and order_state |
Choosing a channel
- Taker / algo: Subscribe to
orderbook_perpsororderbook_optionsfiltered by instrument to see the full book. - Maker: Subscribe to
orderbook_makerwith your address to monitor only your resting orders across all instruments. - Both: You can subscribe to multiple orderbook channels simultaneously. Events are deduplicated by
order_id.
Related channels
| Channel | Why |
|---|---|
| Trade | Execution details (fees, IV, index price at fill). Orderbook events show order state changes; trade events show the fill itself. |
| Account State | Margin and risk impact after fills. Watch im, mm, and equity changes. |
| Position | Position size and Greeks update after fills. |
| MMP | Market Maker Protection freeze events. When MMP triggers, all mmp: true orders are cancelled — reflected as cancel_order events. |
| Index Price | Fair value context for order prices. |
Updated 5 days ago
