Order Book Snapshot
flow_orderbookOrder-book snapshot for one coin's perpetuals: best bid/ask, spread in bps, top-of-book depth (USD) per side, and bid/ask depth imbalance. Positive imbalance means more bid depth. Single-venue by nature — Hyperliquid, falling back to Bybit for coins it doesn't list; the response names the venue that answered.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | Coin symbol, e.g. "BTC". |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asOfAt | No | Order-book timestamp, ISO-8601 UTC | |
| asOfMs | No | Order-book timestamp, Unix epoch milliseconds | |
| source | No | Venue that served the book | |
| symbol | Yes | ||
| spreadBps | No | Bid/ask spread, basis points of mid | |
| bestAskUsd | No | Best ask price, USD | |
| bestBidUsd | No | Best bid price, USD | |
| askDepthUsd | No | Top-of-book ask depth, USD | |
| bidDepthUsd | No | Top-of-book bid depth, USD | |
| midPriceUsd | No | Mid price, USD | |
| imbalancePct | No | Signed bid-vs-ask depth skew in percentage points (positive = more bids) |