This hook requires the
OrderbookProvider to be present in your component tree to provide the underlying Orderbook instance.Import
Usage
Parameters
If true, the hook will unsubscribe from the data pipeline and stop updating state. Useful for optimizing performance in background tabs or collapsed UI elements.
Return Type
Returns anOrderbookData object containing:
State
Related
Orderbook Core
Explore the underlying class logic and event emitters.
useOrderbookHistory
Access historical orderbook data.
useOrderbookStatus
Check if the data is currently “live” or “disconnected”.
Kraken API
Explore the
book channel streams level 2 order book docs.
