> ## Documentation Index
> Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Capabilities
> What each venue serves by data type, as GET /v1/capabilities reports it: REST routes, WebSocket channels, live and replay, first served time, page limits.
Check whether a venue serves a data type, and how, before you call it. `GET /v1/capabilities` returns one row per venue and data type, and the tables on this page are rendered from that response, so they match what the API serves.
The route is public: it needs no API key and costs no credits. Responses are cached for up to five minutes. The Python, TypeScript, and Rust SDKs return the same rows from `client.capabilities()`.
```bash theme={"theme":"github-dark"}
curl "https://api.0xarchive.io/v1/capabilities"
```
```json theme={"theme":"github-dark"}
{
"success": true,
"data": [
{
"venue": "hip3",
"datatype": "l4_diffs",
"rest_routes": ["/v1/hyperliquid/hip3/orderbook/{symbol}/l4/diffs"],
"ws_channels": ["hip3_l4_diffs"],
"live": true,
"replay": true,
"available_from": "2026-03-11T01:03:00.000Z",
"cadence": "event",
"page_limit": 10000,
"intervals": [],
"notes": "WebSocket replay is bulk (speed is ignored) and single-channel only; it starts at the nearest L4 checkpoint and opens with its snapshot."
}
],
"meta": { "count": 98, "request_id": "44c71090-2732-4960-9278-cace4f2c234d" }
}
```
## Row fields
| Field | Meaning |
| - | - |
| `venue` | `hyperliquid`, `hip3`, `hip4`, `spot`, `lighter`, or `rh-lighter`. The same values appear in `meta.venue` on per-symbol responses |
| `datatype` | The data type, for example `trades`, `l2_orderbook`, `l4_diffs`, `funding` |
| `rest_routes` | REST routes that serve it. An empty list means it is WebSocket only |
| `ws_channels` | WebSocket channels that carry it. An empty list means it is REST only |
| `live` | `true` when a live WebSocket subscription is available |
| `replay` | `true` when WebSocket historical replay is available |
| `available_from` | The first served time for this data type on this venue, as RFC 3339 UTC. `null` when no single start applies; use `/v1/symbols` for per-symbol dates |
| `cadence` | How rows are produced: `event` (one row per event), `snapshot` (point-in-time state), `sample` (periodic readings), `interval` (aggregated buckets), or `reference` (catalog data) |
| `page_limit` | The largest `limit` the REST routes accept. `null` when the route returns a single object or sets its own limits |
| `intervals` | Accepted `interval` values for aggregated series. Empty when the route takes no interval |
| `notes` | Anything a client needs to know, for example that replay is bulk or that `available_from` is a policy floor |
| `ws_endpoint` | The WebSocket endpoint that serves the channels, on a row whose channels are not on the default endpoint, such as the `mempool` row. Absent means the default endpoint, `wss://api.0xarchive.io/ws` |
| `plans` | The plans that include the data type, on a row that not every plan includes, such as the `mempool` row. Absent means every plan, Free included |
## Use it before you call
* Check `live` and `replay` before opening a WebSocket subscription or replay. A channel that does not offer a mode answers with `error_code` `unsupported_for_venue`.
* Start history requests at or after `available_from`. A range that straddles it is served from that point; a range that ends before a policy floor returns `range_before_coverage`. Per-symbol starts can be later than the venue-wide start, so check `/v1/symbols` for a specific market.
* Size pages with `page_limit` and aggregate with a value from `intervals`.
* Build channel and venue allow-lists in your own code from this response instead of hard-coding them, so a newly added replay channel or venue needs no code change.
A data type that a venue does not offer has no row. Requesting it over REST returns `404` with `error_code` `unsupported_for_venue` and a list of the venues that do offer it; see [Errors](/errors).
## Matrix
Each cell lists the REST routes, the WebSocket channel and its modes, the first served time, the plans for a data type that not every plan includes, the cadence, the page limit, and any intervals. "No venue-wide start date" and "No fixed page limit" mean the response has no value for that field. The notes under each table repeat the row's `notes` text. L4 and full-depth order book replay is bulk (`speed` is ignored) and single-channel, anchored at the nearest L4 checkpoint; see [WebSocket replay](/websocket/replay).
### Hyperliquid
Venue key `hyperliquid`. REST routes are relative to `/v1/hyperliquid/`.
| Data type | Routes and availability |
| - | - |
| [L2 order book](/rest-api/order-books-l2) | `orderbook/{symbol}`, `orderbook/{symbol}/history`
WebSocket `orderbook`: live and replay
From 2023-04-15
Cadence: snapshot
Up to 1,000 rows a page |
| [Full-depth L2](/rest-api/order-books-l2) | `orderbook/{symbol}/l2`, `orderbook/{symbol}/l2/history`
WebSocket `orderbook_full`: live and replay
From 2026-03-11 01:03 UTC
Cadence: snapshot
Up to 100 rows a page |
| [Full-depth L2 diffs](/rest-api/order-books-l2) | `orderbook/{symbol}/l2/diffs`
REST only, no WebSocket channel
From 2026-03-11 01:03 UTC
Cadence: event
Up to 1,000 rows a page |
| [L4 order book](/rest-api/order-books-l4) | `orderbook/{symbol}/l4`, `orderbook/{symbol}/l4/history`
REST only, no WebSocket channel
From 2026-03-11 01:03 UTC
Cadence: snapshot
Up to 10 rows a page |
| [L4 diffs](/rest-api/order-books-l4) | `orderbook/{symbol}/l4/diffs`
WebSocket `l4_diffs`: live and replay
From 2026-03-11 01:03 UTC
Cadence: event
Up to 10,000 rows a page |
| [Order history (L4 order events)](/rest-api/order-history) | `orders/{symbol}/history`
WebSocket `l4_orders`: live and replay
From 2026-03-11 01:03 UTC
Cadence: event
Up to 10,000 rows a page |
| [Order flow](/rest-api/order-flow) | `orders/{symbol}/flow`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: interval
Up to 10,000 rows a page
Intervals: `1m` `5m` `15m` `1h` |
| [Take profits and stop losses](/rest-api/tpsl) | `orders/{symbol}/tpsl`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: event
Up to 10,000 rows a page |
| [Trigger levels](/rest-api/tpsl) | `orders/{symbol}/trigger-levels`, `orders/{symbol}/trigger-levels/history`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
Up to 100 rows a page |
| [Projected liquidation levels](/rest-api/liquidation-levels) | `liquidations/{symbol}/levels`, `liquidations/{symbol}/levels/history`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
Up to 100 rows a page |
| [Trades](/rest-api/trades) | `trades/{symbol}`
WebSocket `trades`: live and replay
From 2023-04-15 03:31 UTC
Cadence: event
Up to 50,000 rows a page |
| [Candles](/rest-api/candles) | `candles/{symbol}`
WebSocket `candles`: replay only
From 2025-03-22 12:00 UTC
Cadence: interval
Up to 10,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` `1w` |
| [Funding](/rest-api/funding) | `funding/{symbol}`, `funding/{symbol}/current`
WebSocket `funding`: live and replay
From 2023-05-20 02:50 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| [Open interest](/rest-api/open-interest) | `openinterest/{symbol}`, `openinterest/{symbol}/current`
WebSocket `open_interest`: live and replay
From 2023-05-20 02:50 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| [Liquidations](/rest-api/liquidations) | `liquidations/{symbol}`, `liquidations/{symbol}/volume`
WebSocket `liquidations`: live and replay
From 2025-12-22
Cadence: event
Up to 1,000 rows a page |
| [Liquidations by user](/rest-api/liquidations) | `liquidations/user/{user}`
REST only, no WebSocket channel
From 2025-12-22
Cadence: event
Up to 1,000 rows a page |
| Cumulative volume delta | `cvd/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: interval
Up to 10,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` `1w` |
| Price history | `prices/{symbol}`
REST only, no WebSocket channel
From 2023-05-20 02:50 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| Market summary | `summary/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Freshness | `freshness/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Instruments | `instruments`, `instruments/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: reference
No fixed page limit |
| [Market breadth](/rest-api/breadth) | `breadth/above-vwap`, `breadth/above-vwap/current`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: interval
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| Wallet profile | `wallets/{address}/profile`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Wallet classification | `wallets/classify`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| [Account positions](/rest-api/positions) | `wallets/{address}/positions`, `wallets/{address}/positions/history`, `wallets/{address}/positions/changes`, `wallets/{address}/account`, `wallets/{address}/account/history`, `positions`, `positions/{symbol}`, `positions/{symbol}/summary`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Ticker | WebSocket only, no REST route
WebSocket `ticker`, `all_tickers`: live only
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: event
No fixed page limit |
| [TWAP](/rest-api/spot) | `twap/{symbol}`, `twap/user/{user}`
REST only, no WebSocket channel
From 2026-06-17 18:00 UTC
Cadence: event
Up to 1,000 rows a page |
| [Pending transactions (mempool)](/websocket/mempool) | WebSocket only, no REST route
WebSocket `mempool`: live only, on `wss://stream.0xarchive.io/ws`
No history: live only and never stored
Plans: Pro, Scale and Enterprise only
Cadence: event
No fixed page limit |
* Full-depth L2: Derived from L4. WebSocket replay is bulk (speed is ignored) and single-channel only, anchored at L4 checkpoints.
* Full-depth L2 diffs: Derived from L4.
* L4 order book: A live or replayed L4 diff stream opens with a full L4 snapshot.
* L4 diffs: WebSocket replay is bulk (speed is ignored) and single-channel only; it starts at the nearest L4 checkpoint and opens with its snapshot.
* Order history (L4 order events): WebSocket replay is bulk (speed is ignored) and single-channel only, anchored at L4 checkpoints.
* Candles: Older rows exist but are not served; available\_from is a policy floor.
* Liquidations: Older rows exist but are not served; available\_from is a policy floor.
* Liquidations by user: Older rows exist but are not served; available\_from is a policy floor.
* Account positions: Page limits: 5,000 rows on wallet/account histories, 2,000 on market listings.
* Pending transactions (mempool): Signed transactions as our Hyperliquid node receives them, before they are in a block, for every Hyperliquid product. Live only, on wss\://stream.0xarchive.io/ws, with the Pro, Scale and Enterprise plans.
### Hyperliquid Spot
Venue key `spot`. REST routes are relative to `/v1/hyperliquid/spot/`.
| Data type | Routes and availability |
| - | - |
| [L2 order book](/rest-api/order-books-l2) | `orderbook/{symbol}`, `orderbook/{symbol}/history`
WebSocket `spot_orderbook`: live only
From 2026-05-05 19:56 UTC
Cadence: snapshot
Up to 1,000 rows a page |
| [L4 order book](/rest-api/order-books-l4) | `orderbook/{symbol}/l4`, `orderbook/{symbol}/l4/history`
REST only, no WebSocket channel
From 2026-05-05 22:57 UTC
Cadence: snapshot
Up to 10 rows a page |
| [L4 diffs](/rest-api/order-books-l4) | `orderbook/{symbol}/l4/diffs`
WebSocket `spot_l4_diffs`: live and replay
From 2026-05-05 22:57 UTC
Cadence: event
Up to 10,000 rows a page |
| [Order history (L4 order events)](/rest-api/order-history) | `orders/{symbol}/history`
WebSocket `spot_l4_orders`: live and replay
From 2026-05-05 22:57 UTC
Cadence: event
Up to 1,000 rows a page |
| [Trades](/rest-api/trades) | `trades/{symbol}`, `trades/{symbol}/recent`
WebSocket `spot_trades`: live only
From 2025-03-22 10:50 UTC
Cadence: event
Up to 50,000 rows a page |
| [Candles](/rest-api/candles) | `candles/{symbol}`
REST only, no WebSocket channel
From 2025-03-22 10:50 UTC
Cadence: interval
Up to 10,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` `1w` |
| Freshness | `freshness/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Instruments | `pairs`, `pairs/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: reference
No fixed page limit |
| [TWAP](/rest-api/spot) | `twap/{symbol}`, `twap/user/{user}`
REST only, no WebSocket channel
From 2026-05-05 13:05 UTC
Cadence: event
Up to 1,000 rows a page |
* L4 order book: A live or replayed L4 diff stream opens with a full L4 snapshot. PURR-USDC has L4 checkpoints from 2026-03-11 01:03 UTC; other pairs from 2026-05-05 or later (HYPE-USDC from 2026-05-13 15:33 UTC).
* L4 diffs: WebSocket replay is bulk (speed is ignored) and single-channel only; it starts at the nearest L4 checkpoint and opens with its snapshot. PURR-USDC has L4 checkpoints from 2026-03-11 01:03 UTC; other pairs from 2026-05-05 or later (HYPE-USDC from 2026-05-13 15:33 UTC).
* Order history (L4 order events): WebSocket replay is bulk (speed is ignored) and single-channel only, anchored at L4 checkpoints (PURR-USDC from 2026-03-11 01:03 UTC; other pairs from 2026-05-05 or later). REST order history reaches back further for every pair.
* Instruments: Spot instruments are listed as pairs.
* TWAP: REST only: the spot\_twap WebSocket channel accepts a subscription but does not stream yet.
### HIP-3
Venue key `hip3`. REST routes are relative to `/v1/hyperliquid/hip3/`.
| Data type | Routes and availability |
| - | - |
| [L2 order book](/rest-api/order-books-l2) | `orderbook/{symbol}`, `orderbook/{symbol}/history`
WebSocket `hip3_orderbook`: live and replay
From 2026-02-16 16:57 UTC
Cadence: snapshot
Up to 1,000 rows a page |
| [Full-depth L2](/rest-api/order-books-l2) | `orderbook/{symbol}/l2`, `orderbook/{symbol}/l2/history`
WebSocket `hip3_orderbook_full`: live and replay
From 2026-03-11 01:03 UTC
Cadence: snapshot
Up to 100 rows a page |
| [Full-depth L2 diffs](/rest-api/order-books-l2) | `orderbook/{symbol}/l2/diffs`
REST only, no WebSocket channel
From 2026-03-11 01:03 UTC
Cadence: event
Up to 1,000 rows a page |
| [L4 order book](/rest-api/order-books-l4) | `orderbook/{symbol}/l4`, `orderbook/{symbol}/l4/history`
REST only, no WebSocket channel
From 2026-03-11 01:03 UTC
Cadence: snapshot
Up to 10 rows a page |
| [L4 diffs](/rest-api/order-books-l4) | `orderbook/{symbol}/l4/diffs`
WebSocket `hip3_l4_diffs`: live and replay
From 2026-03-11 01:03 UTC
Cadence: event
Up to 10,000 rows a page |
| [Order history (L4 order events)](/rest-api/order-history) | `orders/{symbol}/history`
WebSocket `hip3_l4_orders`: live and replay
From 2026-03-11 01:03 UTC
Cadence: event
Up to 10,000 rows a page |
| [Order flow](/rest-api/order-flow) | `orders/{symbol}/flow`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: interval
Up to 10,000 rows a page
Intervals: `1m` `5m` `15m` `1h` |
| [Take profits and stop losses](/rest-api/tpsl) | `orders/{symbol}/tpsl`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: event
Up to 10,000 rows a page |
| [Trigger levels](/rest-api/tpsl) | `orders/{symbol}/trigger-levels`, `orders/{symbol}/trigger-levels/history`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
Up to 100 rows a page |
| [Projected liquidation levels](/rest-api/liquidation-levels) | `liquidations/{symbol}/levels`, `liquidations/{symbol}/levels/history`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
Up to 100 rows a page |
| [Trades](/rest-api/trades) | `trades/{symbol}`, `trades/{symbol}/recent`
WebSocket `hip3_trades`: live and replay
From 2025-10-13 12:24 UTC
Cadence: event
Up to 50,000 rows a page |
| [Candles](/rest-api/candles) | `candles/{symbol}`
WebSocket `hip3_candles`: replay only
From 2025-12-22
Cadence: interval
Up to 10,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` `1w` |
| [Funding](/rest-api/funding) | `funding/{symbol}`, `funding/{symbol}/current`
WebSocket `hip3_funding`: live and replay
From 2026-02-16 17:03 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| [Open interest](/rest-api/open-interest) | `openinterest/{symbol}`, `openinterest/{symbol}/current`
WebSocket `hip3_open_interest`: live and replay
From 2026-02-16 17:03 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| [Liquidations](/rest-api/liquidations) | `liquidations/{symbol}`, `liquidations/{symbol}/volume`
WebSocket `hip3_liquidations`: live and replay
From 2025-12-22
Cadence: event
Up to 1,000 rows a page |
| Cumulative volume delta | `cvd/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: interval
Up to 10,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` `1w` |
| Price history | `prices/{symbol}`
REST only, no WebSocket channel
From 2025-10-13 12:12 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| Market summary | `summary/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Freshness | `freshness/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Instruments | `instruments`, `instruments/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: reference
No fixed page limit |
| [Market breadth](/rest-api/breadth) | `breadth/above-vwap`, `breadth/above-vwap/current`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: interval
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| [Oracle](/rest-api/hip3) | `oracle/external-price/{symbol}`, `oracle/discovery-bounds/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: event
No fixed page limit |
| Wallet profile | `wallets/{address}/profile`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Wallet classification | `wallets/classify`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| [Account positions](/rest-api/positions) | `wallets/{address}/positions`, `wallets/{address}/positions/history`, `wallets/{address}/positions/changes`, `wallets/{address}/account`, `wallets/{address}/account/history`, `positions`, `positions/{symbol}`, `positions/{symbol}/summary`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| [TWAP](/rest-api/spot) | `twap/{symbol}`, `twap/user/{user}`
REST only, no WebSocket channel
From 2026-06-17 18:00 UTC
Cadence: event
Up to 1,000 rows a page |
* Full-depth L2: Derived from L4. WebSocket replay is bulk (speed is ignored) and single-channel only, anchored at L4 checkpoints.
* Full-depth L2 diffs: Derived from L4.
* L4 order book: A live or replayed L4 diff stream opens with a full L4 snapshot.
* L4 diffs: WebSocket replay is bulk (speed is ignored) and single-channel only; it starts at the nearest L4 checkpoint and opens with its snapshot.
* Order history (L4 order events): WebSocket replay is bulk (speed is ignored) and single-channel only, anchored at L4 checkpoints.
* Price history: HIP-3 prices read the oracle stream, which reaches back further than open interest.
* Account positions: Page limits: 5,000 rows on wallet/account histories, 2,000 on market listings.
### HIP-4
Venue key `hip4`. REST routes are relative to `/v1/hyperliquid/hip4/`.
| Data type | Routes and availability |
| - | - |
| [L2 order book](/rest-api/order-books-l2) | `orderbook/{symbol}`, `orderbook/{symbol}/history`
WebSocket `hip4_orderbook`: replay only
From 2026-05-02 16:51 UTC
Cadence: snapshot
Up to 1,000 rows a page |
| [L4 order book](/rest-api/order-books-l4) | `orderbook/{symbol}/l4`, `orderbook/{symbol}/l4/history`
REST only, no WebSocket channel
From 2026-05-02 07:47 UTC
Cadence: snapshot
Up to 10 rows a page |
| [L4 diffs](/rest-api/order-books-l4) | `orderbook/{symbol}/l4/diffs`
WebSocket `hip4_l4_diffs`: live and replay
From 2026-05-02 07:47 UTC
Cadence: event
Up to 10,000 rows a page |
| [Order history (L4 order events)](/rest-api/order-history) | `orders/{symbol}/history`
WebSocket `hip4_l4_orders`: live and replay
From 2026-05-02 07:47 UTC
Cadence: event
Up to 10,000 rows a page |
| [Order flow](/rest-api/order-flow) | `orders/{symbol}/flow`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: interval
Up to 10,000 rows a page
Intervals: `1m` `5m` `15m` `1h` |
| [Take profits and stop losses](/rest-api/tpsl) | `orders/{symbol}/tpsl`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: event
Up to 10,000 rows a page |
| [Trades](/rest-api/trades) | `trades/{symbol}`, `trades/{symbol}/recent`
WebSocket `hip4_trades`: live and replay
From 2026-05-02 08:00 UTC
Cadence: event
Up to 50,000 rows a page |
| [Candles](/rest-api/candles) | `candles/{symbol}`
REST only, no WebSocket channel
From 2026-05-02 08:00 UTC
Cadence: interval
Up to 10,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` `1w` |
| [Open interest](/rest-api/open-interest) | `openinterest/{symbol}`, `openinterest/{symbol}/current`
WebSocket `hip4_open_interest`: replay only
From 2026-05-02 16:51 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| Price history | `prices/{symbol}`
REST only, no WebSocket channel
From 2026-05-02 16:51 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| Market summary | `summary/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Freshness | `freshness/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Instruments | `instruments`, `instruments/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: reference
Up to 1,000 rows a page |
| [TWAP](/rest-api/spot) | `twap/{symbol}`, `twap/user/{user}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: event
Up to 1,000 rows a page |
| [Outcomes](/rest-api/hip4) | `outcomes`, `outcomes/by-slug/{slug}`, `outcomes/{outcome_id}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: reference
Up to 1,000 rows a page |
| [Questions](/rest-api/hip4) | `questions`, `questions/{question_id}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: reference
Up to 1,000 rows a page |
* L2 order book: WebSocket replay only: the live channel accepts a subscription but does not stream yet.
* L4 order book: A live or replayed L4 diff stream opens with a full L4 snapshot.
* L4 diffs: WebSocket replay is bulk (speed is ignored) and single-channel only; it starts at the nearest L4 checkpoint and opens with its snapshot.
* Order history (L4 order events): WebSocket replay is bulk (speed is ignored) and single-channel only, anchored at L4 checkpoints.
* Candles: Prices are implied probabilities (0 to 1); quote volume is in USDH.
* Open interest: WebSocket replay only: the live channel accepts a subscription but does not stream yet.
* TWAP: HIP-4 TWAP orders before capture began were not recorded; history starts at the first captured TWAP.
### Lighter
Venue key `lighter`. REST routes are relative to `/v1/lighter/`.
| Data type | Routes and availability |
| - | - |
| [L2 order book](/rest-api/order-books-l2) | `orderbook/{symbol}`, `orderbook/{symbol}/history`
WebSocket `lighter_orderbook`: live and replay
From 2026-01-29 02:13 UTC
Cadence: snapshot
Up to 1,000 rows a page |
| [L3 order book](/rest-api/order-books-l3) | `l3orderbook/{symbol}`, `l3orderbook/{symbol}/history`
WebSocket `lighter_l3_orderbook`: replay only
From 2026-03-05 03:33 UTC
Cadence: snapshot
Up to 1,000 rows a page |
| [Trades](/rest-api/trades) | `trades/{symbol}`, `trades/{symbol}/recent`
WebSocket `lighter_trades`: live and replay
From 2025-01-17 08:43 UTC
Cadence: event
Up to 50,000 rows a page |
| [Candles](/rest-api/candles) | `candles/{symbol}`
WebSocket `lighter_candles`: replay only
From 2025-08-01
Cadence: interval
Up to 10,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` `1w` |
| [Funding](/rest-api/funding) | `funding/{symbol}`, `funding/{symbol}/current`
WebSocket `lighter_funding`: live and replay
From 2025-08-25 15:28 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| [Open interest](/rest-api/open-interest) | `openinterest/{symbol}`, `openinterest/{symbol}/current`
WebSocket `lighter_open_interest`: live and replay
From 2025-08-25 15:28 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| [Liquidations](/rest-api/liquidations) | `liquidations/{symbol}`, `liquidations/{symbol}/volume`
REST only, no WebSocket channel
From 2026-06-10
Cadence: event
Up to 1,000 rows a page |
| Price history | `prices/{symbol}`
REST only, no WebSocket channel
From 2025-08-25 15:28 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| Market summary | `summary/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Freshness | `freshness/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Instruments | `instruments`, `instruments/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: reference
No fixed page limit |
| [Account positions](/rest-api/positions) | `accounts`, `accounts/{account_index}/positions`, `accounts/{account_index}/positions/history`, `accounts/{account_index}/positions/changes`, `accounts/{account_index}/account`, `accounts/{account_index}/account/history`, `positions`, `positions/{symbol}`, `positions/{symbol}/summary`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
* L2 order book: History granularity: checkpoint (default), 30s, 10s, 1s or tick.
* Trades: Trades up to meta.finalized\_through are canonical; /recent and live trades are preliminary. Served trade history begins at this row; exact starts vary by market.
* Liquidations: Older rows exist but are not served; available\_from is a policy floor.
* Account positions: Page limits: 5,000 rows on wallet/account histories, 2,000 on market listings.
### Lighter on Robinhood Chain
Venue key `rh-lighter`. REST routes are relative to `/v1/rh-lighter/`.
| Data type | Routes and availability |
| - | - |
| [L2 order book](/rest-api/order-books-l2) | `orderbook/{symbol}`, `orderbook/{symbol}/history`
WebSocket `rh_lighter_orderbook`: live and replay
From 2026-08-22 18:43 UTC
Cadence: snapshot
Up to 1,000 rows a page |
| [Trades](/rest-api/trades) | `trades/{symbol}`, `trades/{symbol}/recent`
WebSocket `rh_lighter_trades`: live and replay
From 2026-06-26 20:10 UTC
Cadence: event
Up to 50,000 rows a page |
| [Candles](/rest-api/candles) | `candles/{symbol}`
WebSocket `rh_lighter_candles`: replay only
From 2026-06-26 20:10 UTC
Cadence: interval
Up to 10,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` `1w` |
| [Funding](/rest-api/funding) | `funding/{symbol}`, `funding/{symbol}/current`
WebSocket `rh_lighter_funding`: live and replay
From 2026-08-22 18:43 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| [Open interest](/rest-api/open-interest) | `openinterest/{symbol}`, `openinterest/{symbol}/current`
WebSocket `rh_lighter_open_interest`: live and replay
From 2026-08-22 18:43 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| [Liquidations](/rest-api/liquidations) | `liquidations/{symbol}`, `liquidations/{symbol}/volume`
REST only, no WebSocket channel
From 2026-06-26 20:10 UTC
Cadence: event
Up to 1,000 rows a page |
| Price history | `prices/{symbol}`
REST only, no WebSocket channel
From 2026-08-22 18:43 UTC
Cadence: sample
Up to 1,000 rows a page
Intervals: `1m` `5m` `15m` `30m` `1h` `4h` `1d` |
| Market summary | `summary/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Freshness | `freshness/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
| Instruments | `instruments`, `instruments/{symbol}`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: reference
No fixed page limit |
| [Account positions](/rest-api/positions) | `accounts/{account_index}/positions`, `accounts/{account_index}/positions/history`, `accounts/{account_index}/positions/changes`, `accounts/{account_index}/account`, `accounts/{account_index}/account/history`, `positions`, `positions/{symbol}`, `positions/{symbol}/summary`
REST only, no WebSocket channel
No venue-wide start date; see `/v1/symbols` per symbol
Cadence: snapshot
No fixed page limit |
* L2 order book: History granularity: checkpoint (default), 30s, 10s, 1s or tick.
* Account positions: Page limits: 5,000 rows on wallet/account histories, 2,000 on market listings.
## Next step
Read the envelope, error, time and pagination rules every route shares on [API conventions](/conventions).
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.