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.

ChannelSubscription scopeGuide
orderbook_perpsBy instrument or pairOrderbook Perps
orderbook_optionsBy instrument, pair, maturity, strike, typeOrderbook Options
orderbook_makerBy 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

EventWhen
post_orderNew limit order enters the book
cancel_orderOrder cancelled (user, expiry, or system)
update_orderPartial fill updates filled_amount and order_state

Choosing a channel

  • Taker / algo: Subscribe to orderbook_perps or orderbook_options filtered by instrument to see the full book.
  • Maker: Subscribe to orderbook_maker with 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

ChannelWhy
TradeExecution details (fees, IV, index price at fill). Orderbook events show order state changes; trade events show the fill itself.
Account StateMargin and risk impact after fills. Watch im, mm, and equity changes.
PositionPosition size and Greeks update after fills.
MMPMarket Maker Protection freeze events. When MMP triggers, all mmp: true orders are cancelled — reflected as cancel_order events.
Index PriceFair value context for order prices.