Skip to main content
WSS
/
v1
/
orderbook

Documentation Index

Fetch the complete documentation index at: https://docs.openpx.trade/llms.txt

Use this file to discover all available pages before exploring further.

Per-market L2 orderbook stream — Snapshot on subscribe, then Delta updates.
Messages
Snapshot
type:object

Full orderbook snapshot — replace any cached book for (market_id, asset_id).

Delta
type:object

Incremental change to an existing book — apply in-place.

Clear
type:object

Book invalidation — drop the cached book and wait for the next Snapshot.

Connected
type:object

Initial socket establishment.

Reconnected
type:object

Socket re-established after an outage — gap_ms is the wall-clock interval since the last received message.

Lagged
type:object

Slow consumer dropped messages — every affected book is invalidated and must be rebuilt from the next Snapshot.

BookInvalidated
type:object

A specific market's book is no longer trustworthy — drop cache and wait for next Snapshot (reasons: Reconnect, Lag, SequenceGap, ExchangeReset).

Error
type:object

A non-fatal error observed on the connection (session continues).

Subscribe
type:object

Add to the active orderbook subscription set

Unsubscribe
type:object

Remove from the active orderbook subscription set