--- title: "REST API: Hyperliquid, HIP-3, HIP-4, Lighter | 0xArchive" description: "Browse 0xArchive REST routes for Hyperliquid, HIP-3, HIP-4 outcomes, Lighter.xyz, data quality, auth, credits, and example requests." canonical_url: "https://www.0xarchive.io/docs/rest-api/" markdown_url: "https://www.0xarchive.io/docs/rest-api.md" route: "/docs/rest-api" robots: "index, follow" generated_from: "prerendered_html" --- # REST API: Hyperliquid perps and spot, Lighter.xyz, HIP-3, and HIP-4 Endpoint reference for Hyperliquid perps and spot, Lighter.xyz, HIP-3, and HIP-4 outcome markets: 105 documented routes covering order books, trades, candles, liquidations, outcomes, TWAP, freshness, credits, parameters, and example requests. Base URL https://api.0xarchive.io Auth X-API-Key header Routes 105 documented routes Coverage Hyperliquid perps and spot, Lighter.xyz, HIP-3, HIP-4 [OpenAPI Spec](https://www.0xarchive.io/openapi.json) ## Overview Hyperliquid, Lighter.xyz, HIP-3, and HIP-4 REST endpoints for order books, trades, candles, order flow, liquidations, outcomes, freshness, and coverage. Use the venue atlas to jump to the right route family. Every route shows parameters, credits, request shape, and response shape without hidden disclosures. [Hyperliquid 37 route s Core perp routes for market state, history, order flow, liquidations, and monitoring.](https://www.0xarchive.io/docs/rest-api/#rest-hyperliquid) [Lighter.xyz 16 route s Lighter routes for market state, history, L3 depth, and reconstruction-heavy jobs.](https://www.0xarchive.io/docs/rest-api/#rest-lighter) [HIP-3 25 route s Builder-perp routes inside the Hyperliquid namespace, including depth, liquidations, and order flow.](https://www.0xarchive.io/docs/rest-api/#rest-hip3) [HIP-4 19 route s Outcome-market routes inside the Hyperliquid namespace: /outcomes discovery, per-side L2/L4 books, trades, OI, and order lifecycle. Coins are referenced by numeric id (0, 1, 10, 11, ...); the #-prefixed form is also accepted for callers integrating from on-chain SDKs.](https://www.0xarchive.io/docs/rest-api/#rest-hip4) [Hyperliquid Spot 12 route s 13 routes under /v1/hyperliquid/spot covering 294 dashed pairs (PURR-USDC, HYPE-USDC, HFUN-USDC, ...): L2/L4 orderbook, trades with builder/twap fields, TWAP by symbol or by user, order lifecycle, pair metadata, and freshness. Spot trades carry fee_token (open-set: USDC, PURR, HYPE, KHYPE, USOL, ...), real EVM tx_hash on roughly 69% of fills, and parent twap_id on TWAP slices. No funding, OI, liquidations, or candles by design (build OHLCV client-side from spot trades).](https://www.0xarchive.io/docs/rest-api/#rest-spot) [Data Quality 8 route s Freshness, incidents, latency, coverage, and health checks.](https://www.0xarchive.io/docs/rest-api/#rest-data-quality) Coverage ### 105 documented routes Hyperliquid perps and spot, Lighter.xyz, HIP-3, and HIP-4 endpoints for order books, trades, candles, TWAP, liquidations, outcomes, freshness, incidents, and coverage. Hyperliquid ### 37 Hyperliquid routes Core perp routes for order books, trades, candles, funding, open interest, liquidations, order flow, and freshness. Lighter.xyz ### 16 Lighter routes Historical and reconstruction-heavy routes for order books, trades, candles, L3 depth, summary, and prices. HIP-3 ### 25 HIP-3 routes Builder-perp REST coverage including L4 depth, order flow, liquidations, candles, funding, and OI. HIP-4 ### 19 HIP-4 routes Outcome-market routes including /outcomes discovery, per-side L2/L4 books, trades, OI, and order lifecycle. Coins are numeric ids (0, 1, 10, 11, ...). Hyperliquid Spot ### 12 Spot routes Spot routes for 294 dashed pairs (PURR-USDC, HYPE-USDC, HFUN-USDC, ...): L2/L4 orderbook, trades with builder/twap fields, TWAP by symbol or by user, pair metadata, and freshness. Data Quality ### 8 monitoring routes Freshness, incidents, latency, SLA, health, and coverage monitoring across every venue. ### Pair the reference with these docs pages [Quick Start Make the first authenticated Hyperliquid order book request before expanding into the full reference.](https://www.0xarchive.io/docs/quick-start/) [API Playground Run a live request in the browser before wiring code or debugging headers.](https://www.0xarchive.io/docs/playground/) [Response Schemas Open field names and payload shapes once you know the route family you need.](https://www.0xarchive.io/docs/schemas/) [Error Handling Use retry rules, plan-gate explanations, and status-code guidance when a route fails.](https://www.0xarchive.io/docs/errors/) ## Hyperliquid Core perp routes for market state, history, order flow, liquidations, and monitoring. ### Hyperliquid - Order Book GET `/v1/hyperliquid/orderbook/:symbol` Copy 1 credit Get current order book or snapshot at specific timestamp Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `timestamp` query Unix timestamp in ms for historical snapshot `depth` query Number of price levels per side. Tier limits: Free=20, Build=200, Pro=Full Depth, Enterprise=Full Depth Request ``` /v1/hyperliquid/orderbook/BTC?timestamp=1704067200000&depth=20 ``` Response ``` { "success": true, "data": { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50", "spread_bps": "1.19" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/orderbook/:symbol/history` Copy 5 credit s Get historical order book snapshots with pagination. Get historical order book snapshots with pagination. Returns sub-second L1 snapshots (~1.2s native cadence) — for tick-level order changes use /orderbook/:symbol/l4/diffs (Pro+) or /orderbook/:symbol/l2/diffs. Data available from April 2023. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) `depth` query Number of price levels per side. Tier limits: Free=20, Build=200, Pro=Full Depth, Enterprise=Full Depth Request ``` /v1/hyperliquid/orderbook/BTC/history?start=1704067200000&end=1704153600000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid - Trades GET `/v1/hyperliquid/trades/:symbol` Copy 2 credit s Get trade history with cursor pagination. Get trade history with cursor pagination. Data available from April 2023 (pre-March 2025 fills are taker-only). Use next_cursor from response to fetch subsequent pages. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Cursor from previous response (next_cursor) `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/trades/ETH?start=1704067200000&end=1704153600000&limit=1000 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "side": "B", "price": "42150.50", "size": "0.25", "trade_id": 12345678, "direction": "Open Long" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid - Market Data GET `/v1/hyperliquid/instruments` Copy 1 credit List all available Hyperliquid trading instruments Request ``` /v1/hyperliquid/instruments ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "exchange": "hyperliquid", "quote": "USDC", "active": true }, { "symbol": "ETH", "exchange": "hyperliquid", "quote": "USDC", "active": true } ], "meta": { "request_id": "req_abc123", "count": 2 } } ``` GET `/v1/hyperliquid/instruments/:symbol` Copy 1 credit Get a single Hyperliquid instrument by symbol, including the latest venue metadata and trading state. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) Request ``` /v1/hyperliquid/instruments/BTC ``` Response ``` { "success": true, "data": { "symbol": "BTC", "exchange": "hyperliquid", "base": "BTC", "quote": "USDC", "active": true, "tick_size": "0.5", "lot_size": "0.001" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/openinterest/:symbol` Copy 2 credit s Get historical open interest data with market context. Get historical open interest data with market context. Data available from May 2023. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Cursor from previous response (next_cursor) `limit` query Max results (default: 100, max: 1000) `interval` query Aggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw ~1 min data. Request ``` /v1/hyperliquid/openinterest/BTC?start=1704067200000&end=1704153600000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "open_interest": "12500.5", "mark_price": "42150.75" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/openinterest/:symbol/current` Copy 1 credit Get current open interest for a symbol Parameters `symbol` path required Trading pair (e.g., BTC, ETH) Request ``` /v1/hyperliquid/openinterest/BTC/current ``` Response ``` { "success": true, "data": { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "open_interest": "12500.5", "mark_price": "42150.75" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/funding/:symbol` Copy 2 credit s Get historical funding rates. Get historical funding rates. Data available from May 2023. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Cursor from previous response (next_cursor) `limit` query Max results (default: 100, max: 1000) `interval` query Aggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw ~1 min data. Request ``` /v1/hyperliquid/funding/BTC?start=1704067200000&end=1704153600000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "funding_rate": "0.0001", "premium": "0.00005" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/funding/:symbol/current` Copy 1 credit Get current funding rate for a symbol Parameters `symbol` path required Trading pair (e.g., BTC, ETH) Request ``` /v1/hyperliquid/funding/BTC/current ``` Response ``` { "success": true, "data": { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "funding_rate": "0.0001", "premium": "0.00005" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/liquidations/:symbol` Copy 3 credit s Get liquidation events for a symbol. Get liquidation events for a symbol. Data available from December 2025+. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Cursor from previous response (format: timestamp_tradeId) `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/liquidations/BTC?start=1704067200000&end=1704153600000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "liquidated_user": "0x1234...abcd", "side": "B", "price": "42150.50", "size": "1.5", "direction": "Close Long" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/liquidations/user/:user` Copy 3 credit s Get liquidation events for a user address. Get liquidation events for a user address. Returns liquidations where the user was liquidated. Data available from December 2025. Parameters `user` path required User wallet address (e.g., 0x...) `start` query required Start timestamp in ms `end` query required End timestamp in ms `symbol` query Optional symbol filter (e.g., BTC) `cursor` query Cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/liquidations/user/0x84eec0068b37919cc8f13d7454073ac167374cc0?start=1704067200000&end=1704153600000 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "liquidated_user": "0x1234...abcd", "side": "B", "price": "42150.50", "size": "1.5", "direction": "Close Long" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/liquidations/:symbol/volume` Copy 3 credit s Get pre-aggregated liquidation volumes in time-bucketed intervals. Get pre-aggregated liquidation volumes in time-bucketed intervals. Returns total, long, and short USD liquidation volumes with counts. Much more efficient than fetching individual liquidation records. Data available from December 2025+. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query Start timestamp (Unix ms or ISO 8601). Defaults to 24h ago. `end` query End timestamp (Unix ms or ISO 8601). Defaults to now. `interval` query Aggregation interval: 5m, 15m, 30m, 1h (default), 4h, 1d `limit` query Max results (default: 100, max: 1000) `cursor` query Pagination cursor from previous response Request ``` /v1/hyperliquid/liquidations/BTC/volume?start=1704067200000&end=1704153600000&interval=1h&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "interval": "1h", "long_volume": "125000.50", "short_volume": "98000.25", "count": 14 } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/freshness/:symbol` Copy 1 credit Check when data was last updated for each data type for a specific symbol. Check when data was last updated for each data type for a specific symbol. Useful for agents and automated systems to verify data currency before pulling large datasets. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) Request ``` /v1/hyperliquid/freshness/BTC ``` Response ``` { "success": true, "data": { "symbol": "BTC", "exchange": "hyperliquid", "latest_timestamp": "2026-01-01T12:00:00Z", "lag_ms": 1200, "status": "fresh" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/summary/:symbol` Copy 2 credit s Get a combined market summary for a symbol in a single API call. Get a combined market summary for a symbol in a single API call. Returns latest price, funding rate, open interest, 24h volume, and 24h liquidation volumes — replacing what would otherwise require 4-5 separate API calls. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) Request ``` /v1/hyperliquid/summary/BTC ``` Response ``` { "success": true, "data": { "symbol": "BTC", "mark_price": "42150.75", "mid_price": "42150.75", "open_interest": "12500.5", "volume_24h": "1250000000", "timestamp": "2026-01-01T12:00:00Z" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/prices/:symbol` Copy 2 credit s Get mark and oracle price history for a symbol. Get mark and oracle price history for a symbol. This route returns price fields only and supports time aggregation intervals. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query Start timestamp (Unix ms or ISO 8601). Defaults to 24h ago. `end` query End timestamp (Unix ms or ISO 8601). Defaults to now. `interval` query Aggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw data. `limit` query Max results (default: 100, max: 1000) `cursor` query Pagination cursor from previous response Request ``` /v1/hyperliquid/prices/BTC?start=1704067200000&end=1704153600000&interval=1h&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "mark_price": "42150.75", "oracle_price": "42148.50", "mid_price": "42150.75" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid - Candles GET `/v1/hyperliquid/candles/:symbol` Copy 3 credit s Get OHLCV candle data aggregated from trades. Get OHLCV candle data aggregated from trades. Data available from March 2025. Supports cursor pagination for large datasets. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `interval` query Candle interval: 1m, 5m, 15m, 30m, 1h (default), 4h, 1d, 1w `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/candles/BTC?start=1704067200000&end=1704153600000&interval=1h&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "interval": "1h", "open": "42100.00", "high": "42200.00", "low": "42050.00", "close": "42180.00", "volume": "125.5" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid - L4 Order Book (Node-Level) GET `/v1/hyperliquid/orders/:symbol/history` Copy 5 credit s Get order history with user attribution from Hyperliquid node data. Get order history with user attribution from Hyperliquid node data. Includes order placements, cancellations, and fills. Requires Pro tier or higher. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `user` query Filter by user wallet address (e.g., 0x...) `status` query Filter by order status (e.g., open, filled, cancelled) `order_type` query Filter by order type (e.g., limit, market) `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/orders/BTC/history?start=1704067200000&end=1704153600000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "order_id": "0xabc", "user_address": "0x1234...abcd", "status": "filled", "side": "B", "price": "42150.50", "size": "1.2" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/orders/:symbol/flow` Copy 5 credit s Get aggregated order flow data showing buy/sell pressure over time intervals. Get aggregated order flow data showing buy/sell pressure over time intervals. Useful for analyzing market microstructure. Requires Pro tier or higher. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `interval` query Aggregation interval (e.g., 1m, 5m, 15m, 1h) `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/orders/BTC/flow?start=1704067200000&end=1704153600000&interval=5m&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "interval": "5m", "new_orders": 1250, "cancels": 1180, "fills": 340, "net_size": "42.5" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/orders/:symbol/tpsl` Copy 5 credit s Get take-profit and stop-loss order history with user attribution. Get take-profit and stop-loss order history with user attribution. Shows triggered and untriggered TP/SL orders. Requires Pro tier or higher. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `user` query Filter by user wallet address (e.g., 0x...) `triggered` query Filter by triggered status (true/false) `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/orders/BTC/tpsl?start=1704067200000&end=1704153600000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "order_id": "0xabc", "trigger_price": "42000.00", "order_type": "stop_market", "side": "A", "size": "0.5" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/orderbook/:symbol/l4` Copy 10 credit s Reconstruct the L4 orderbook at a specific point in time, showing individual orders with user attribution at each price level. Reconstruct the L4 orderbook at a specific point in time, showing individual orders with user attribution at each price level. Requires Pro tier or higher. Data available from March 11, 2026. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `timestamp` query required Unix timestamp in ms for reconstruction point `depth` query Number of price levels per side (default: 20) Request ``` /v1/hyperliquid/orderbook/BTC/l4?timestamp=1704067200000&depth=20 ``` Response ``` { "success": true, "data": { "symbol": "BTC", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/orderbook/:symbol/l4/diffs` Copy 5 credit s Get L4 orderbook diffs showing individual order changes with user attribution. Get L4 orderbook diffs showing individual order changes with user attribution. Each diff represents an order placement, cancellation, or fill. Requires Pro tier or higher. Data available from March 10, 2026. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/orderbook/BTC/l4/diffs?start=1704067200000&end=1704153600000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/orderbook/:symbol/l4/history` Copy 10 credit s Get L4 orderbook checkpoints (full snapshots) with user attribution at each price level. Get L4 orderbook checkpoints (full snapshots) with user attribution at each price level. Useful for periodic state verification. Requires Build tier or higher. Data available from March 11, 2026. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/orderbook/BTC/l4/history?start=1704067200000&end=1704153600000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid - L2 Full-Depth Order Book (Derived from L4) GET `/v1/hyperliquid/orderbook/:symbol/l2` Copy 3 credit s Get the full-depth L2 orderbook at a specific point in time, derived from L4 data. Get the full-depth L2 orderbook at a specific point in time, derived from L4 data. Returns aggregated price levels (price, total size, order count per level). If no timestamp is provided, returns the current state. Requires Build tier or higher. Data available from April 1, 2026. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `timestamp` query Unix timestamp in ms (omit for current state) `depth` query Number of price levels per side (omit for full depth) Request ``` /v1/hyperliquid/orderbook/BTC/l2?depth=20 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/orderbook/:symbol/l2/history` Copy 10 credit s Get paginated L2 full-depth checkpoints over a time range. Get paginated L2 full-depth checkpoints over a time range. Each checkpoint is a complete orderbook snapshot with all price levels. Requires Build tier or higher. Data available from April 1, 2026. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/orderbook/BTC/l2/history?start=1704067200000&end=1704153600000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/orderbook/:symbol/l2/diffs` Copy 5 credit s Get tick-level L2 orderbook deltas showing price-level changes over time. Get tick-level L2 orderbook deltas showing price-level changes over time. Each delta contains price, new size, and side. Requires Pro tier or higher. Data available from April 1, 2026. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/orderbook/BTC/l2/diffs?start=1704067200000&end=1704153600000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid Spot - Pair Metadata (294 pairs: PURR-USDC, HYPE-USDC, HFUN-USDC, ...) GET `/v1/hyperliquid/spot/pairs` Copy 1 credit List all 294 spot pairs with base/quote tokens and dashed symbols. List all 294 spot pairs with base/quote tokens and dashed symbols. No tier restriction. Symbols use the dashed form (e.g., PURR-USDC); the server resolves the wire format (PURR/USDC, @) internally. Request ``` /v1/hyperliquid/spot/pairs ``` Response ``` { "success": true, "data": [ { "symbol": "PURR-USDC", "base": "PURR", "quote": "USDC", "wire": "PURR/USDC", "pair_index": 107 }, { "symbol": "HYPE-USDC", "base": "HYPE", "quote": "USDC", "wire": "HYPE/USDC", "pair_index": 150 }, { "symbol": "HFUN-USDC", "base": "HFUN", "quote": "USDC", "wire": "HFUN/USDC", "pair_index": 161 } ], "meta": { "request_id": "req_abc123", "count": 3 } } ``` GET `/v1/hyperliquid/spot/pairs/:symbol` Copy 1 credit Get metadata for a single spot pair, including base/quote tokens and the underlying wire-format identifier. Parameters `symbol` path required Spot symbol in dashed form (e.g., PURR-USDC, HYPE-USDC, HFUN-USDC). Raw @ identifiers are not accepted; use the named pair. Request ``` /v1/hyperliquid/spot/pairs/PURR-USDC ``` Response ``` { "success": true, "data": { "symbol": "PURR-USDC", "base": "PURR", "quote": "USDC", "wire": "PURR/USDC", "pair_index": 107 }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/spot/freshness/:symbol` Copy 1 credit Data freshness for a spot pair: latest timestamps and lag for orderbook, trades, L4, and TWAP. Parameters `symbol` path required Spot symbol (e.g., PURR-USDC, HYPE-USDC). Request ``` /v1/hyperliquid/spot/freshness/PURR-USDC ``` Response ``` { "success": true, "data": { "symbol": "PURR-USDC", "exchange": "hyperliquid_spot", "latest_timestamp": "2026-01-01T12:00:00Z", "lag_ms": 1200, "status": "fresh" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` ### Hyperliquid Spot - Order Book (Build+) GET `/v1/hyperliquid/spot/orderbook/:symbol` Copy 1 credit Get current L2 order book for a Hyperliquid Spot pair. Get current L2 order book for a Hyperliquid Spot pair. Build+ tier required. Live-only from 2026-05-05 (Hyperliquid does not publish historical spot orderbook data). Parameters `symbol` path required Spot symbol (e.g., PURR-USDC, HYPE-USDC). `depth` query Price levels per side (max 20). Request ``` /v1/hyperliquid/spot/orderbook/PURR-USDC?depth=10 ``` Response ``` { "success": true, "data": { "symbol": "PURR-USDC", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50", "spread_bps": "1.19" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/spot/orderbook/:symbol/history` Copy 5 credit s Get historical L2 spot orderbook snapshots with cursor pagination. Get historical L2 spot orderbook snapshots with cursor pagination. Available from 2026-05-05. Build+ tier required. Parameters `symbol` path required Spot symbol (e.g., HYPE-USDC). `start` query required Start timestamp in ms. `end` query required End timestamp in ms. `depth` query Price levels per side (max 20). `cursor` query Pagination cursor from previous response. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/orderbook/HYPE-USDC/history?start=1746489600000&end=1746576000000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "PURR-USDC", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/spot/orderbook/:symbol/l4` Copy 10 credit s Full-depth L4 order book reconstruction with user attribution. Full-depth L4 order book reconstruction with user attribution. Pro+ tier required. Live-only from 2026-05-05. Parameters `symbol` path required Spot symbol (e.g., PURR-USDC). `timestamp` query Reconstruct at this Unix ms timestamp; defaults to latest. Request ``` /v1/hyperliquid/spot/orderbook/PURR-USDC/l4?timestamp=1746576000000 ``` Response ``` { "success": true, "data": { "symbol": "PURR-USDC", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/spot/orderbook/:symbol/l4/diffs` Copy 3 credit s L4 order-level changes (place, cancel, modify, fill) with user attribution. L4 order-level changes (place, cancel, modify, fill) with user attribution. Pro+ tier required. Live-only from 2026-05-05. Parameters `symbol` path required Spot symbol (e.g., PURR-USDC). `start` query required Start timestamp in ms. `end` query required End timestamp in ms. `cursor` query Pagination cursor. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/orderbook/PURR-USDC/l4/diffs?start=1746489600000&end=1746576000000&limit=500 ``` Response ``` { "success": true, "data": [ { "symbol": "PURR-USDC", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/spot/orderbook/:symbol/l4/history` Copy 3 credit s L4 checkpoint history. L4 checkpoint history. Build+ tier required. Live-only from 2026-05-05. Parameters `symbol` path required Spot symbol (e.g., PURR-USDC). `start` query required Start timestamp in ms. `end` query required End timestamp in ms. `cursor` query Pagination cursor. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/orderbook/PURR-USDC/l4/history?start=1746489600000&end=1746576000000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "PURR-USDC", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid Spot - Trades (Build+) GET `/v1/hyperliquid/spot/trades/:symbol` Copy 2 credit s Get spot trade history with verbose schema: builder_address, builder_fee, twap_id, fee_token (open-set: USDC, PURR, HYPE, KHYPE, USOL, ...), and real EVM tx_hash (~69% non-zero for spot, vs all-zero for perps). Get spot trade history with verbose schema: builder_address, builder_fee, twap_id, fee_token (open-set: USDC, PURR, HYPE, KHYPE, USOL, ...), and real EVM tx_hash (~69% non-zero for spot, vs all-zero for perps). Backfilled from 2025-03-22; pre-March 2025 spot history is unrecoverable from any free public archive. Parameters `symbol` path required Spot symbol (e.g., PURR-USDC, HYPE-USDC). `start` query required Start timestamp in ms. `end` query required End timestamp in ms. `cursor` query Pagination cursor. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/trades/PURR-USDC?start=1742601600000&end=1742688000000&limit=500 ``` Response ``` { "success": true, "data": [ { "symbol": "PURR-USDC", "timestamp": "2026-01-01T12:00:00Z", "side": "B", "price": "42150.50", "size": "0.25", "trade_id": 12345678, "direction": "Open Long" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid Spot - Order Lifecycle (Build+) GET `/v1/hyperliquid/spot/orders/:symbol/history` Copy 3 credit s Order lifecycle events (place, cancel, modify, fill) for a spot pair. Order lifecycle events (place, cancel, modify, fill) for a spot pair. Build+ tier required. Live-only from 2026-05-05. Parameters `symbol` path required Spot symbol (e.g., HYPE-USDC). `start` query required Start timestamp in ms. `end` query required End timestamp in ms. `user` query Filter by user wallet address. `cursor` query Pagination cursor. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/orders/HYPE-USDC/history?start=1746489600000&end=1746576000000&limit=200 ``` Response ``` { "success": true, "data": [ { "symbol": "PURR-USDC", "timestamp": "2026-01-01T12:00:00Z", "order_id": "0xabc", "user_address": "0x1234...abcd", "status": "filled", "side": "B", "price": "42150.50", "size": "1.2" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid Spot - TWAP (Build+) GET `/v1/hyperliquid/spot/twap/:symbol` Copy 2 credit s TWAP execution events for a spot pair, with parent twap_id, fill schedule, and counter-party attribution. TWAP execution events for a spot pair, with parent twap_id, fill schedule, and counter-party attribution. Build+ tier required. Live-only from 2026-05-05. Parameters `symbol` path required Spot symbol (e.g., HYPE-USDC). `start` query required Start timestamp in ms. `end` query required End timestamp in ms. `cursor` query Pagination cursor. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/twap/HYPE-USDC?start=1746489600000&end=1746576000000&limit=200 ``` Response ``` { "success": true, "data": [ { "coin": "HYPE/USDC", "symbol": "HYPE-USDC", "twap_id": 7732, "user_address": "0x44ad...8b9c", "side": "A", "slice_price": "24.875", "slice_size": "12.3", "timestamp": "2026-05-05T17:13:25.119Z", "parent_total_size": "120.0", "completed_size": "36.9", "status": "progressing" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/spot/twap/user/:user` Copy 2 credit s TWAP execution events filtered by user wallet across all spot pairs. TWAP execution events filtered by user wallet across all spot pairs. Build+ tier required. Parameters `user` path required User wallet address (0x...). `start` query Start timestamp in ms. `end` query End timestamp in ms. `cursor` query Pagination cursor. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/twap/user/0x023a3d058020fb76cca98f01b3c48c8938a22355?limit=100 ``` Response ``` { "success": true, "data": [ { "coin": "HYPE/USDC", "symbol": "HYPE-USDC", "twap_id": 7732, "user_address": "0x44ad...8b9c", "side": "A", "slice_price": "24.875", "slice_size": "12.3", "timestamp": "2026-05-05T17:13:25.119Z", "parent_total_size": "120.0", "completed_size": "36.9", "status": "progressing" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ## Lighter.xyz Lighter routes for market state, history, L3 depth, and reconstruction-heavy jobs. ### Lighter.xyz - Order Book GET `/v1/lighter/orderbook/:symbol` Copy 2 credit s Get current order book snapshot Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `timestamp` query Unix timestamp in ms for historical snapshot `depth` query Number of price levels per side. Tier limits: Free=20, Build=200, Pro=Full Depth, Enterprise=Full Depth Request ``` /v1/lighter/orderbook/BTC?depth=50 ``` Response ``` { "success": true, "data": { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50", "spread_bps": "1.19" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/lighter/orderbook/:symbol/history` Copy 10 credit s Get historical order book data with pagination. Get historical order book data with pagination. Returns either tick-level events or sub-second snapshots depending on the granularity parameter — checkpoint (1-min, default), 30s, 10s, 1s, or tick (Enterprise; returns checkpoint + deltas for client-side reconstruction). Data available from January 2026. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) `depth` query Number of price levels per side. Tier limits: Free=20, Build=200, Pro=Full Depth, Enterprise=Full Depth `granularity` query Data resolution: checkpoint (1min, default), 30s, 10s, 1s, tick. Higher resolutions require higher tier plans. When granularity=tick (Enterprise only), response returns checkpoint + deltas for client-side reconstruction. Request ``` /v1/lighter/orderbook/BTC/history?start=1704067200000&end=1704153600000&limit=100&granularity=10s&depth=50 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Lighter.xyz - Trades GET `/v1/lighter/trades/:symbol` Copy 2 credit s Get trade history with cursor pagination. Get trade history with cursor pagination. Data available from August 2025. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Cursor from previous response (next_cursor) `limit` query Max results (default: 100, max: 1000) Request ``` /v1/lighter/trades/ETH?start=1704067200000&end=1704153600000&limit=1000 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "side": "B", "price": "42150.50", "size": "0.25", "trade_id": 12345678, "direction": "Open Long" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/lighter/trades/:symbol/recent` Copy 1 credit Get most recent trades Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `limit` query Number of trades to return (default: 100, max: 1000) Request ``` /v1/lighter/trades/BTC/recent?limit=50 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "side": "B", "price": "42150.50", "size": "0.25", "trade_id": 12345678, "direction": "Open Long" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Lighter.xyz - Market Data GET `/v1/lighter/instruments` Copy 1 credit List all available Lighter.xyz trading instruments Request ``` /v1/lighter/instruments ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "exchange": "lighter", "quote": "USDC", "active": true }, { "symbol": "ETH", "exchange": "lighter", "quote": "USDC", "active": true } ], "meta": { "request_id": "req_abc123", "count": 2 } } ``` GET `/v1/lighter/instruments/:symbol` Copy 1 credit Get a single Lighter.xyz instrument by symbol Parameters `symbol` path required Trading pair (e.g., BTC, ETH) Request ``` /v1/lighter/instruments/BTC ``` Response ``` { "success": true, "data": { "symbol": "BTC", "exchange": "lighter", "base": "BTC", "quote": "USDC", "active": true, "tick_size": "0.5", "lot_size": "0.001" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/lighter/openinterest/:symbol` Copy 2 credit s Get historical open interest data. Get historical open interest data. Data available from August 2025. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Cursor from previous response (next_cursor) `limit` query Max results (default: 100, max: 1000) `interval` query Aggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw ~1 min data. Request ``` /v1/lighter/openinterest/BTC?start=1704067200000&end=1704153600000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "open_interest": "12500.5", "mark_price": "42150.75" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/lighter/openinterest/:symbol/current` Copy 1 credit Get current open interest for a symbol Parameters `symbol` path required Trading pair (e.g., BTC, ETH) Request ``` /v1/lighter/openinterest/BTC/current ``` Response ``` { "success": true, "data": { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "open_interest": "12500.5", "mark_price": "42150.75" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/lighter/funding/:symbol` Copy 2 credit s Get historical funding rates. Get historical funding rates. Data available from August 2025. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Cursor from previous response (next_cursor) `limit` query Max results (default: 100, max: 1000) `interval` query Aggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw ~1 min data. Request ``` /v1/lighter/funding/BTC?start=1704067200000&end=1704153600000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "funding_rate": "0.0001", "premium": "0.00005" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/lighter/funding/:symbol/current` Copy 1 credit Get current funding rate for a symbol Parameters `symbol` path required Trading pair (e.g., BTC, ETH) Request ``` /v1/lighter/funding/BTC/current ``` Response ``` { "success": true, "data": { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "funding_rate": "0.0001", "premium": "0.00005" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` ### Lighter.xyz - Candles GET `/v1/lighter/candles/:symbol` Copy 3 credit s Get OHLCV candle data aggregated from trades. Get OHLCV candle data aggregated from trades. Data available from August 2025. Supports cursor pagination for large datasets. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `interval` query Candle interval: 1m, 5m, 15m, 30m, 1h (default), 4h, 1d, 1w `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/lighter/candles/BTC?start=1704067200000&end=1704153600000&interval=15m&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "interval": "1h", "open": "42100.00", "high": "42200.00", "low": "42050.00", "close": "42180.00", "volume": "125.5" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Lighter.xyz - Convenience GET `/v1/lighter/freshness/:symbol` Copy 1 credit Check when data was last updated for each data type (orderbook, trades, funding, OI) for a specific Lighter.xyz coin. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) Request ``` /v1/lighter/freshness/BTC ``` Response ``` { "success": true, "data": { "symbol": "BTC", "exchange": "lighter", "latest_timestamp": "2026-01-01T12:00:00Z", "lag_ms": 1200, "status": "fresh" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/lighter/summary/:symbol` Copy 2 credit s Get a combined market summary for a Lighter.xyz symbol in a single API call. Get a combined market summary for a Lighter.xyz symbol in a single API call. Returns latest price, funding rate, and open interest. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) Request ``` /v1/lighter/summary/BTC ``` Response ``` { "success": true, "data": { "symbol": "BTC", "mark_price": "42150.75", "mid_price": "42150.75", "open_interest": "12500.5", "volume_24h": "1250000000", "timestamp": "2026-01-01T12:00:00Z" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/lighter/prices/:symbol` Copy 2 credit s Get mark and oracle price history for a Lighter.xyz symbol. Get mark and oracle price history for a Lighter.xyz symbol. Lightweight projection of open interest data. Supports time aggregation intervals. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query Start timestamp (Unix ms or ISO 8601). Defaults to 24h ago. `end` query End timestamp (Unix ms or ISO 8601). Defaults to now. `interval` query Aggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw data. `limit` query Max results (default: 100, max: 1000) `cursor` query Pagination cursor from previous response Request ``` /v1/lighter/prices/BTC?start=1704067200000&end=1704153600000&interval=1h&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "mark_price": "42150.75", "oracle_price": "42148.50", "mid_price": "42150.75" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Lighter.xyz - L3 Order Book (Order-Level) GET `/v1/lighter/l3orderbook/:symbol` Copy 5 credit s Get current L3 order-level orderbook showing individual orders at each price level with order IDs and sizes. Get current L3 order-level orderbook showing individual orders at each price level with order IDs and sizes. Requires Pro tier or higher. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `depth` query Number of price levels per side (default: 20) Request ``` /v1/lighter/l3orderbook/BTC?depth=20 ``` Response ``` { "success": true, "data": { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "status": "ok" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/lighter/l3orderbook/:symbol/history` Copy 10 credit s Get historical L3 orderbook snapshots showing individual orders at each price level. Get historical L3 orderbook snapshots showing individual orders at each price level. Data available from March 2026. Requires Pro tier or higher. Parameters `symbol` path required Trading pair (e.g., BTC, ETH) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) `depth` query Number of price levels per side (default: 20) Request ``` /v1/lighter/l3orderbook/BTC/history?start=1704067200000&end=1704153600000&limit=100&depth=20 ``` Response ``` { "success": true, "data": { "symbol": "BTC", "timestamp": "2026-01-01T12:00:00Z", "status": "ok" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` ## HIP-3 Builder-perp routes inside the Hyperliquid namespace, including depth, liquidations, and order flow. ### Hyperliquid HIP-3 - Instruments (125+ markets: xyz, flx, hyna, km, vntl, cash) GET `/v1/hyperliquid/hip3/instruments` Copy 1 credit List all available HIP-3 builder-deployed perpetuals with latest market data (mark price, open interest, mid price). List all available HIP-3 builder-deployed perpetuals with latest market data (mark price, open interest, mid price). No tier restriction - useful for market inventory. Request ``` /v1/hyperliquid/hip3/instruments ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "exchange": "hyperliquid_hip3", "quote": "USDC", "active": true }, { "symbol": "xyz:XYZ100", "exchange": "hyperliquid_hip3", "quote": "USDC", "active": true } ], "meta": { "request_id": "req_abc123", "count": 2 } } ``` GET `/v1/hyperliquid/hip3/instruments/:symbol` Copy 1 credit Get a specific HIP-3 instrument by symbol. Get a specific HIP-3 instrument by symbol. Returns latest market data. Parameters `symbol` path required HIP-3 symbol (e.g., km:US500, xyz:XYZ100). Case-sensitive. Request ``` /v1/hyperliquid/hip3/instruments/km:US500 ``` Response ``` { "success": true, "data": { "symbol": "km:US500", "exchange": "hyperliquid_hip3", "base": "US500", "quote": "USDC", "active": true, "tick_size": "0.5", "lot_size": "0.001" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` ### Hyperliquid HIP-3 - Order Book (Free: km:US500, Build+: all) GET `/v1/hyperliquid/hip3/orderbook/:symbol` Copy 1 credit Get current order book or snapshot at specific timestamp for HIP-3 builder-deployed perpetuals. Get current order book or snapshot at specific timestamp for HIP-3 builder-deployed perpetuals. Free tier: km:US500 only. Build+: all symbols. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) `timestamp` query Unix timestamp in ms for historical snapshot `depth` query Number of price levels per side. Tier limits: Free=20, Build=200, Pro=Full Depth, Enterprise=Full Depth Request ``` /v1/hyperliquid/hip3/orderbook/xyz:XYZ100?depth=50 ``` Response ``` { "success": true, "data": { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50", "spread_bps": "1.19" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/hip3/orderbook/:symbol/history` Copy 5 credit s Get historical order book snapshots with cursor pagination. Get historical order book snapshots with cursor pagination. Returns sub-second L1 snapshots — for tick-level order changes use /hip3/orderbook/:symbol/l4/diffs (Pro+) or /hip3/orderbook/:symbol/l2/diffs. Data available from February 2026. Free tier: km:US500 only. Build+: all symbols. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) `depth` query Number of price levels per side. Tier limits: Free=20, Build=200, Pro=Full Depth, Enterprise=Full Depth Request ``` /v1/hyperliquid/hip3/orderbook/xyz:XYZ100/history?start=1739750400000&end=1739836800000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid HIP-3 - Trades (Free: km:US500, Build+: all) GET `/v1/hyperliquid/hip3/trades/:symbol` Copy 2 credit s Get trade history with cursor pagination. Get trade history with cursor pagination. Data available from February 2026. Free tier: km:US500 only. Build+: all symbols. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Cursor from previous response (next_cursor) `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip3/trades/xyz:XYZ100?start=1739750400000&end=1739836800000&limit=1000 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "side": "B", "price": "42150.50", "size": "0.25", "trade_id": 12345678, "direction": "Open Long" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip3/trades/:symbol/recent` Copy 1 credit Get most recent trades for a HIP-3 symbol. Get most recent trades for a HIP-3 symbol. Data available from February 2026. No tier restriction. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) `limit` query Number of trades to return (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip3/trades/xyz:XYZ100/recent?limit=50 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "side": "B", "price": "42150.50", "size": "0.25", "trade_id": 12345678, "direction": "Open Long" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid HIP-3 - Candles (Free: km:US500, Build+: all) GET `/v1/hyperliquid/hip3/candles/:symbol` Copy 3 credit s Get OHLCV candle data aggregated from HIP-3 trades. Get OHLCV candle data aggregated from HIP-3 trades. Data available from February 2026. Free tier: km:US500 only. Build+: all symbols. Parameters `symbol` path required HIP-3 symbol (e.g., km:US500, xyz:XYZ100). Case-sensitive. `start` query required Start timestamp in ms `end` query required End timestamp in ms `interval` query Candle interval: 1m, 5m, 15m, 30m, 1h (default), 4h, 1d, 1w `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip3/candles/km:US500?start=1739750400000&end=1739836800000&interval=1h&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "interval": "1h", "open": "42100.00", "high": "42200.00", "low": "42050.00", "close": "42180.00", "volume": "125.5" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid HIP-3 - Market Data (Free: km:US500, Build+: all) GET `/v1/hyperliquid/hip3/openinterest/:symbol` Copy 2 credit s Get historical open interest data. Get historical open interest data. Data available from February 2026. Free tier: km:US500 only. Build+: all symbols. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Cursor from previous response (next_cursor) `limit` query Max results (default: 100, max: 1000) `interval` query Aggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw ~1 min data. Request ``` /v1/hyperliquid/hip3/openinterest/xyz:XYZ100?start=1739750400000&end=1739836800000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "open_interest": "12500.5", "mark_price": "42150.75" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip3/openinterest/:symbol/current` Copy 1 credit Get current open interest for a HIP-3 symbol. Get current open interest for a HIP-3 symbol. No tier restriction. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) Request ``` /v1/hyperliquid/hip3/openinterest/xyz:XYZ100/current ``` Response ``` { "success": true, "data": { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "open_interest": "12500.5", "mark_price": "42150.75" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/hip3/funding/:symbol` Copy 2 credit s Get historical funding rates. Get historical funding rates. Data available from February 2026. Free tier: km:US500 only. Build+: all symbols. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Cursor from previous response (next_cursor) `limit` query Max results (default: 100, max: 1000) `interval` query Aggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw ~1 min data. Request ``` /v1/hyperliquid/hip3/funding/xyz:XYZ100?start=1739750400000&end=1739836800000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "funding_rate": "0.0001", "premium": "0.00005" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip3/funding/:symbol/current` Copy 1 credit Get current funding rate for a HIP-3 symbol. Get current funding rate for a HIP-3 symbol. No tier restriction. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) Request ``` /v1/hyperliquid/hip3/funding/xyz:XYZ100/current ``` Response ``` { "success": true, "data": { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "funding_rate": "0.0001", "premium": "0.00005" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` ### Hyperliquid HIP-3 - Liquidations (Build+) GET `/v1/hyperliquid/hip3/liquidations/:symbol` Copy 3 credit s Get liquidation-related fills for a HIP-3 symbol. Get liquidation-related fills for a HIP-3 symbol. Returns the liquidated user plus counterparty/liquidator attribution when present, alongside price, size, side, and direction labels. Data available from February 2026+. Parameters `symbol` path required HIP-3 symbol (e.g., km:US500, xyz:XYZ100). Case-sensitive. `start` query required Start timestamp in ms `end` query End timestamp in ms. Defaults to now. `cursor` query Cursor from previous response (format: timestamp_tradeId) `limit` query Max results (default: 1000, max: 1000) Request ``` /v1/hyperliquid/hip3/liquidations/km:US500?start=1739750400000&end=1739836800000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "liquidated_user": "0x1234...abcd", "side": "B", "price": "42150.50", "size": "1.5", "direction": "Close Long" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip3/liquidations/:symbol/volume` Copy 3 credit s Get pre-aggregated liquidation-related volume in time-bucketed intervals for HIP-3 symbols. Get pre-aggregated liquidation-related volume in time-bucketed intervals for HIP-3 symbols. total_* covers all liquidation rows; long_* and short_* are directional-family subtotals and may not sum to total when upstream emits unclassified directions. Data available from February 2026+. Parameters `symbol` path required HIP-3 symbol (e.g., km:US500, xyz:XYZ100). Case-sensitive. `start` query required Start timestamp in ms `end` query End timestamp in ms. Defaults to now. `interval` query Aggregation interval: 5m, 15m, 30m, 1h (default), 4h, 1d `limit` query Max results (default: 1000, max: 1000) `cursor` query Pagination cursor from previous response Request ``` /v1/hyperliquid/hip3/liquidations/km:US500/volume?start=1739750400000&end=1739836800000&interval=1h&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "interval": "1h", "long_volume": "125000.50", "short_volume": "98000.25", "count": 14 } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid HIP-3 - Convenience GET `/v1/hyperliquid/hip3/freshness/:symbol` Copy 1 credit Check when data was last updated for each data type (orderbook, trades, funding, OI) for a specific HIP-3 symbol. Check when data was last updated for each data type (orderbook, trades, funding, OI) for a specific HIP-3 symbol. Symbol names are case-sensitive. Parameters `symbol` path required HIP-3 symbol (e.g., km:US500, xyz:XYZ100) Request ``` /v1/hyperliquid/hip3/freshness/km:US500 ``` Response ``` { "success": true, "data": { "symbol": "km:US500", "exchange": "hyperliquid_hip3", "latest_timestamp": "2026-01-01T12:00:00Z", "lag_ms": 1200, "status": "fresh" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/hip3/summary/:symbol` Copy 2 credit s Get a combined market summary for a HIP-3 symbol in a single API call. Get a combined market summary for a HIP-3 symbol in a single API call. Returns latest price, mid price, funding rate, and open interest. Parameters `symbol` path required HIP-3 symbol (e.g., km:US500, xyz:XYZ100) Request ``` /v1/hyperliquid/hip3/summary/km:US500 ``` Response ``` { "success": true, "data": { "symbol": "km:US500", "mark_price": "42150.75", "mid_price": "42150.75", "open_interest": "12500.5", "volume_24h": "1250000000", "timestamp": "2026-01-01T12:00:00Z" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/hip3/prices/:symbol` Copy 2 credit s Get mark, oracle, and mid price history for a HIP-3 symbol. Get mark, oracle, and mid price history for a HIP-3 symbol. Lightweight projection of open interest data. Supports time aggregation intervals. Symbol names are case-sensitive. Parameters `symbol` path required HIP-3 symbol (e.g., km:US500, xyz:XYZ100) `start` query Start timestamp (Unix ms or ISO 8601). Defaults to 24h ago. `end` query End timestamp (Unix ms or ISO 8601). Defaults to now. `interval` query Aggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw data. `limit` query Max results (default: 100, max: 1000) `cursor` query Pagination cursor from previous response Request ``` /v1/hyperliquid/hip3/prices/km:US500?start=1739750400000&end=1739836800000&interval=1h&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "mark_price": "42150.75", "oracle_price": "42148.50", "mid_price": "42150.75" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid HIP-3 - L4 Order Book (Node-Level) GET `/v1/hyperliquid/hip3/orders/:symbol/history` Copy 5 credit s Get HIP-3 order history with user attribution from Hyperliquid node data. Get HIP-3 order history with user attribution from Hyperliquid node data. Includes order placements, cancellations, and fills. Requires Pro tier or higher. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) `start` query required Start timestamp in ms `end` query required End timestamp in ms `user` query Filter by user wallet address (e.g., 0x...) `status` query Filter by order status (e.g., open, filled, cancelled) `order_type` query Filter by order type (e.g., limit, market) `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip3/orders/km:US500/history?start=1739750400000&end=1739836800000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "order_id": "0xabc", "user_address": "0x1234...abcd", "status": "filled", "side": "B", "price": "42150.50", "size": "1.2" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip3/orders/:symbol/flow` Copy 5 credit s Get aggregated order flow data for HIP-3 markets showing buy/sell pressure over time intervals. Get aggregated order flow data for HIP-3 markets showing buy/sell pressure over time intervals. Requires Pro tier or higher. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) `start` query required Start timestamp in ms `end` query required End timestamp in ms `interval` query Aggregation interval (e.g., 1m, 5m, 15m, 1h) `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip3/orders/km:US500/flow?start=1739750400000&end=1739836800000&interval=5m&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "interval": "5m", "new_orders": 1250, "cancels": 1180, "fills": 340, "net_size": "42.5" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip3/orders/:symbol/tpsl` Copy 5 credit s Get HIP-3 take-profit and stop-loss order history with user attribution. Get HIP-3 take-profit and stop-loss order history with user attribution. Shows triggered and untriggered TP/SL orders. Requires Pro tier or higher. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) `start` query required Start timestamp in ms `end` query required End timestamp in ms `user` query Filter by user wallet address (e.g., 0x...) `triggered` query Filter by triggered status (true/false) `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip3/orders/km:US500/tpsl?start=1739750400000&end=1739836800000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "order_id": "0xabc", "trigger_price": "42000.00", "order_type": "stop_market", "side": "A", "size": "0.5" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip3/orderbook/:symbol/l4` Copy 10 credit s Reconstruct the HIP-3 L4 orderbook at a specific point in time, showing individual orders with user attribution at each price level. Reconstruct the HIP-3 L4 orderbook at a specific point in time, showing individual orders with user attribution at each price level. Requires Pro tier or higher. Data available from March 11, 2026. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) `timestamp` query required Unix timestamp in ms for reconstruction point `depth` query Number of price levels per side (default: 20) Request ``` /v1/hyperliquid/hip3/orderbook/km:US500/l4?timestamp=1739750400000&depth=20 ``` Response ``` { "success": true, "data": { "symbol": "km:US500", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/hip3/orderbook/:symbol/l4/diffs` Copy 5 credit s Get HIP-3 L4 orderbook diffs showing individual order changes with user attribution. Get HIP-3 L4 orderbook diffs showing individual order changes with user attribution. Each diff represents an order placement, cancellation, or fill. Requires Pro tier or higher. Data available from March 10, 2026. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip3/orderbook/km:US500/l4/diffs?start=1739750400000&end=1739836800000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip3/orderbook/:symbol/l4/history` Copy 10 credit s Get HIP-3 L4 orderbook checkpoints (full snapshots) with user attribution at each price level. Get HIP-3 L4 orderbook checkpoints (full snapshots) with user attribution at each price level. Useful for periodic state verification. Requires Build tier or higher. Data available from March 11, 2026. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:XYZ100, km:US500) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip3/orderbook/km:US500/l4/history?start=1739750400000&end=1739836800000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid HIP-3 - L2 Full-Depth Order Book (Derived from L4) GET `/v1/hyperliquid/hip3/orderbook/:symbol/l2` Copy 3 credit s Get the HIP-3 full-depth L2 orderbook at a specific point in time, derived from L4 data. Get the HIP-3 full-depth L2 orderbook at a specific point in time, derived from L4 data. Returns aggregated price levels. If no timestamp is provided, returns the current state. Requires Build tier or higher. Data available from April 1, 2026. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:CL, km:US500) `timestamp` query Unix timestamp in ms (omit for current state) `depth` query Number of price levels per side (omit for full depth) Request ``` /v1/hyperliquid/hip3/orderbook/km:US500/l2?depth=20 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip3/orderbook/:symbol/l2/history` Copy 10 credit s Get paginated HIP-3 L2 full-depth checkpoints over a time range. Get paginated HIP-3 L2 full-depth checkpoints over a time range. Each checkpoint is a complete orderbook snapshot. Requires Build tier or higher. Data available from April 1, 2026. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:CL, km:US500) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip3/orderbook/km:US500/l2/history?start=1739750400000&end=1739836800000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip3/orderbook/:symbol/l2/diffs` Copy 5 credit s Get tick-level HIP-3 L2 orderbook deltas showing price-level changes over time. Get tick-level HIP-3 L2 orderbook deltas showing price-level changes over time. Each delta contains price, new size, and side. Requires Pro tier or higher. Data available from April 1, 2026. Parameters `symbol` path required HIP-3 symbol (e.g., xyz:CL, km:US500) `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip3/orderbook/km:US500/l2/diffs?start=1739750400000&end=1739836800000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "km:US500", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ## HIP-4 Outcome-market routes inside the Hyperliquid namespace: /outcomes discovery, per-side L2/L4 books, trades, OI, and order lifecycle. Coins are referenced by numeric id (0, 1, 10, 11, ...); the #-prefixed form is also accepted for callers integrating from on-chain SDKs. ### Hyperliquid HIP-4 - Outcomes (Build+) GET `/v1/hyperliquid/hip4/outcomes` Copy 1 credit List HIP-4 outcome markets (binary prediction events). List HIP-4 outcome markets (binary prediction events). Each outcome has Yes (side 0) and No (side 1) sides. Filter by `is_settled` to scope to live or settled markets. Cursor pagination. Response excludes `aggregated_oi` (call /outcomes/:outcome_id for OI snapshots). Requires Build tier or higher. Parameters `is_settled` query Filter by settlement status: true or false `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip4/outcomes?is_settled=false&limit=100 ``` Response ``` { "success": true, "data": [ { "outcome_id": 0, "name": "BTC >= 78213 by 2026-05-03 06:00 UTC", "class": "priceBinary", "underlying": "BTC", "expiry": "2026-05-03T06:00:00Z", "target_price": 78213, "period": "1d", "side_specs": [ { "side": 0, "name": "Yes", "coin": "#0", "asset_id": 100000000 }, { "side": 1, "name": "No", "coin": "#1", "asset_id": 100000001 } ], "is_settled": false, "status": "live", "source_seen_at": "2026-05-02T20:25:00Z" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip4/outcomes/:outcome_id` Copy 1 credit Get a single HIP-4 outcome market by id, including the latest both-sides aggregated OI snapshot (display, paired-set supply, parity flag). Get a single HIP-4 outcome market by id, including the latest both-sides aggregated OI snapshot (display, paired-set supply, parity flag). Requires Build tier or higher. Parameters `outcome_id` path required Outcome id (integer, e.g., 0) Request ``` /v1/hyperliquid/hip4/outcomes/0 ``` Response ``` { "success": true, "data": { "outcome_id": 0, "name": "BTC >= 78213 by 2026-05-03 06:00 UTC", "description_raw": "class:priceBinary|underlying:BTC|expiry:20260503-0600|targetPrice:78213|period:1d", "class": "priceBinary", "underlying": "BTC", "expiry": "2026-05-03T06:00:00Z", "target_price": 78213, "period": "1d", "side_specs": [ { "side": 0, "name": "Yes", "coin": "#0", "asset_id": 100000000 }, { "side": 1, "name": "No", "coin": "#1", "asset_id": 100000001 } ], "is_settled": false, "status": "live", "source_seen_at": "2026-05-02T20:25:00Z", "aggregated_oi": { "side0_open_interest_contracts": 568048, "side1_open_interest_contracts": 568048, "outcome_display_open_interest_contracts": 1136096, "paired_set_supply_contracts": 568048, "side_supply_parity": true, "currency": "USDH", "as_of": "2026-05-02T20:27:21Z", "side0_as_of": "2026-05-02T20:27:21Z", "side1_as_of": "2026-05-02T20:27:21Z" } }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` ### Hyperliquid HIP-4 - Instruments (Build+) GET `/v1/hyperliquid/hip4/instruments` Copy 1 credit List per-side HIP-4 instruments (one row per `#N` coin). List per-side HIP-4 instruments (one row per `#N` coin). Each outcome contributes two rows (Yes side `#0`, No side `#1` etc.). Requires Build tier or higher. Request ``` /v1/hyperliquid/hip4/instruments ``` Response ``` { "success": true, "data": [ { "outcome_id": 0, "side": 0, "asset_id": 100000000, "coin": "#0", "symbol": "#0", "side_name": "Yes", "is_settled": false }, { "outcome_id": 0, "side": 1, "asset_id": 100000001, "coin": "#1", "symbol": "#1", "side_name": "No", "is_settled": false } ], "meta": { "request_id": "req_abc123", "count": 2 } } ``` GET `/v1/hyperliquid/hip4/instruments/:symbol` Copy 1 credit Get a specific HIP-4 instrument by coin id. Get a specific HIP-4 instrument by coin id. Requires Build tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). Encoding: 10*outcome_id + side. #-prefixed form also accepted. Request ``` /v1/hyperliquid/hip4/instruments/0 ``` Response ``` { "success": true, "data": { "outcome_id": 0, "side": 0, "asset_id": 100000000, "coin": "#0", "symbol": "#0", "name": "BTC >= 78213 by 2026-05-03 06:00 UTC - Yes", "description": "class:priceBinary|underlying:BTC|expiry:20260503-0600|targetPrice:78213|period:1d", "side_name": "Yes", "recurring_class": "priceBinary", "recurring_underlying": "BTC", "recurring_expiry": "2026-05-03T06:00:00Z", "recurring_target_px": 78213, "recurring_period": "1d", "builder_address": "0x1234...abcd", "is_settled": false, "first_seen_at": "2026-05-02T07:47:00Z", "last_updated_at": "2026-05-02T20:25:00Z" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` ### Hyperliquid HIP-4 - Order Book (Pro+ for L2/L4) GET `/v1/hyperliquid/hip4/orderbook/:symbol` Copy 1 credit Get current L2 order book snapshot for a HIP-4 outcome side. Get current L2 order book snapshot for a HIP-4 outcome side. Requires Pro tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. `timestamp` query Unix timestamp in ms for historical snapshot `depth` query Number of price levels per side. Tier limits: Free=20, Build=200, Pro=Full Depth, Enterprise=Full Depth Request ``` /v1/hyperliquid/hip4/orderbook/0?depth=20 ``` Response ``` { "success": true, "data": { "symbol": "#0", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50", "spread_bps": "1.19" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/hip4/orderbook/:symbol/history` Copy 5 credit s Get historical HIP-4 L2 order book snapshots with cursor pagination. Get historical HIP-4 L2 order book snapshots with cursor pagination. Returns sub-second L1 snapshots. Data available from 2026-05-02. Requires Pro tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) `depth` query Number of price levels per side. Tier limits: Free=20, Build=200, Pro=Full Depth, Enterprise=Full Depth Request ``` /v1/hyperliquid/hip4/orderbook/0/history?start=1746144000000&end=1746230400000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "#0", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip4/orderbook/:symbol/l4` Copy 10 credit s Reconstruct the HIP-4 L4 orderbook for a side at a specific point in time, showing individual orders with user attribution at each price level. Reconstruct the HIP-4 L4 orderbook for a side at a specific point in time, showing individual orders with user attribution at each price level. Requires Pro tier or higher. Data available from 2026-05-02. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. `timestamp` query required Unix timestamp in ms for reconstruction point `depth` query Number of price levels per side (default: 20) Request ``` /v1/hyperliquid/hip4/orderbook/0/l4?timestamp=1746144000000&depth=20 ``` Response ``` { "success": true, "data": { "symbol": "#0", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/hip4/orderbook/:symbol/l4/diffs` Copy 5 credit s Get HIP-4 L4 orderbook diffs (event stream) showing individual order changes with user attribution. Get HIP-4 L4 orderbook diffs (event stream) showing individual order changes with user attribution. ASC + cursor pagination. Requires Pro tier or higher. Data available from 2026-05-02. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip4/orderbook/0/l4/diffs?start=1746144000000&end=1746230400000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "#0", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip4/orderbook/:symbol/l4/history` Copy 10 credit s Get HIP-4 L4 orderbook checkpoints (full snapshots) with user attribution. Get HIP-4 L4 orderbook checkpoints (full snapshots) with user attribution. Hard cap `limit=10`. Requires Build tier or higher. Data available from 2026-05-02. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Pagination cursor from previous response `limit` query Max results (default: 10, max: 10) Request ``` /v1/hyperliquid/hip4/orderbook/0/l4/history?start=1746144000000&end=1746230400000&limit=10 ``` Response ``` { "success": true, "data": [ { "symbol": "#0", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid HIP-4 - Trades (Build+) GET `/v1/hyperliquid/hip4/trades/:symbol` Copy 2 credit s Get HIP-4 fills history (full) with cursor pagination. Get HIP-4 fills history (full) with cursor pagination. Requires Build tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Cursor from previous response (next_cursor) `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip4/trades/0?start=1746144000000&end=1746230400000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "#0", "timestamp": "2026-01-01T12:00:00Z", "side": "B", "price": "42150.50", "size": "0.25", "trade_id": 12345678, "direction": "Open Long" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip4/trades/:symbol/recent` Copy 1 credit Get last N HIP-4 fills, latest first. Get last N HIP-4 fills, latest first. Requires Build tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. `limit` query Number of trades to return (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip4/trades/0/recent?limit=50 ``` Response ``` { "success": true, "data": [ { "symbol": "#0", "timestamp": "2026-01-01T12:00:00Z", "side": "B", "price": "42150.50", "size": "0.25", "trade_id": 12345678, "direction": "Open Long" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid HIP-4 - Market Data (Build+) GET `/v1/hyperliquid/hip4/openinterest/:symbol` Copy 2 credit s Get historical HIP-4 side open interest with cursor pagination. Get historical HIP-4 side open interest with cursor pagination. Mirrors HIP-3 OI byte-for-byte (single-table, no joins). For both-sides display/paired/parity fields use /outcomes/:outcome_id. Requires Build tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. `start` query required Start timestamp in ms `end` query required End timestamp in ms `cursor` query Cursor from previous response (next_cursor) `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip4/openinterest/0?start=1746144000000&end=1746230400000&limit=100 ``` Response ``` { "success": true, "data": [ { "coin": "#0", "symbol": "#0", "outcome_id": 0, "side": 0, "timestamp": "2026-05-02T20:27:21Z", "open_interest": "568048", "mark_price": "0.6502", "mid_price": "0.65038" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip4/openinterest/:symbol/current` Copy 1 credit Get the latest HIP-4 side open interest row. Get the latest HIP-4 side open interest row. `mark_price` for HIP-4 is an implied probability in [0,1], not USD. Requires Build tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. Request ``` /v1/hyperliquid/hip4/openinterest/0/current ``` Response ``` { "success": true, "data": { "coin": "#0", "symbol": "#0", "outcome_id": 0, "side": 0, "timestamp": "2026-05-02T20:27:21Z", "open_interest": "568048", "mark_price": "0.6502", "mid_price": "0.65038" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/hip4/prices/:symbol` Copy 2 credit s Get HIP-4 mid-price history for a side. Get HIP-4 mid-price history for a side. `mark_price` is an implied probability in [0,1], not USD. No oracle price feed for HIP-4. Requires Build tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. `start` query Start timestamp (Unix ms or ISO 8601). Defaults to 24h ago. `end` query End timestamp (Unix ms or ISO 8601). Defaults to now. `interval` query Aggregation interval: 5m, 15m, 30m, 1h, 4h, 1d. When omitted, returns raw data. `limit` query Max results (default: 100, max: 1000) `cursor` query Pagination cursor from previous response Request ``` /v1/hyperliquid/hip4/prices/0?start=1746144000000&end=1746230400000&interval=1h&limit=100 ``` Response ``` { "success": true, "data": [ { "coin": "#0", "symbol": "#0", "timestamp": "2026-05-02T20:27:21Z", "mark_price": "0.6502", "mid_price": "0.65038" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip4/summary/:symbol` Copy 2 credit s Get a 24h aggregate (price, volume, OI) for a HIP-4 side. Get a 24h aggregate (price, volume, OI) for a HIP-4 side. `mark_price` is an implied probability. Requires Build tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. Request ``` /v1/hyperliquid/hip4/summary/0 ``` Response ``` { "success": true, "data": { "coin": "#0", "symbol": "#0", "outcome_id": 0, "side": 0, "mark_price": "0.6502", "mid_price": "0.65038", "open_interest": "568048", "volume_24h": "1250000", "timestamp": "2026-05-02T20:27:21Z" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/hip4/freshness/:symbol` Copy 1 credit Get per-data-type lag breakdown for a HIP-4 side (orderbook, trades, OI). Get per-data-type lag breakdown for a HIP-4 side (orderbook, trades, OI). Requires Build tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. Request ``` /v1/hyperliquid/hip4/freshness/0 ``` Response ``` { "success": true, "data": { "symbol": "#0", "exchange": "hyperliquid_hip4", "latest_timestamp": "2026-01-01T12:00:00Z", "lag_ms": 1200, "status": "fresh" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` ### Hyperliquid HIP-4 - Order Lifecycle (Pro+) GET `/v1/hyperliquid/hip4/orders/:symbol/history` Copy 5 credit s Get HIP-4 order lifecycle events with user attribution from Hyperliquid node data. Get HIP-4 order lifecycle events with user attribution from Hyperliquid node data. Includes order placements, cancellations, and fills. Requires Pro tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. `start` query required Start timestamp in ms `end` query required End timestamp in ms `user` query Filter by user wallet address (e.g., 0x...) `status` query Filter by order status (e.g., open, filled, cancelled) `order_type` query Filter by order type (e.g., limit, market) `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip4/orders/0/history?start=1746144000000&end=1746230400000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "#0", "timestamp": "2026-01-01T12:00:00Z", "order_id": "0xabc", "user_address": "0x1234...abcd", "status": "filled", "side": "B", "price": "42150.50", "size": "1.2" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip4/orders/:symbol/flow` Copy 5 credit s Get time-bucketed HIP-4 order-flow aggregates showing buy/sell pressure over intervals. Get time-bucketed HIP-4 order-flow aggregates showing buy/sell pressure over intervals. Requires Pro tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. `start` query required Start timestamp in ms `end` query required End timestamp in ms `interval` query Aggregation interval (e.g., 1m, 5m, 15m, 1h, 1d) `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip4/orders/0/flow?start=1746144000000&end=1746230400000&interval=1h&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "#0", "timestamp": "2026-01-01T12:00:00Z", "interval": "5m", "new_orders": 1250, "cancels": 1180, "fills": 340, "net_size": "42.5" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/hip4/orders/:symbol/tpsl` Copy 5 credit s Get HIP-4 take-profit and stop-loss orders for the symbol with user attribution. Get HIP-4 take-profit and stop-loss orders for the symbol with user attribution. Requires Pro tier or higher. Parameters `symbol` path required HIP-4 coin id (e.g., 0 for outcome 0 Yes side, 1 for No side). #-prefixed form also accepted. `start` query required Start timestamp in ms `end` query required End timestamp in ms `user` query Filter by user wallet address (e.g., 0x...) `triggered` query Filter by triggered status (true/false) `cursor` query Pagination cursor from previous response `limit` query Max results (default: 100, max: 1000) Request ``` /v1/hyperliquid/hip4/orders/0/tpsl?start=1746144000000&end=1746230400000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "#0", "timestamp": "2026-01-01T12:00:00Z", "order_id": "0xabc", "trigger_price": "42000.00", "order_type": "stop_market", "side": "A", "size": "0.5" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ## Hyperliquid Spot 13 routes under /v1/hyperliquid/spot covering 294 dashed pairs (PURR-USDC, HYPE-USDC, HFUN-USDC, ...): L2/L4 orderbook, trades with builder/twap fields, TWAP by symbol or by user, order lifecycle, pair metadata, and freshness. Spot trades carry fee_token (open-set: USDC, PURR, HYPE, KHYPE, USOL, ...), real EVM tx_hash on roughly 69% of fills, and parent twap_id on TWAP slices. No funding, OI, liquidations, or candles by design (build OHLCV client-side from spot trades). ### Hyperliquid Spot - Pair Metadata (294 pairs: PURR-USDC, HYPE-USDC, HFUN-USDC, ...) GET `/v1/hyperliquid/spot/pairs` Copy 1 credit List all 294 spot pairs with base/quote tokens and dashed symbols. List all 294 spot pairs with base/quote tokens and dashed symbols. No tier restriction. Symbols use the dashed form (e.g., PURR-USDC); the server resolves the wire format (PURR/USDC, @) internally. Request ``` /v1/hyperliquid/spot/pairs ``` Response ``` { "success": true, "data": [ { "symbol": "PURR-USDC", "base": "PURR", "quote": "USDC", "wire": "PURR/USDC", "pair_index": 107 }, { "symbol": "HYPE-USDC", "base": "HYPE", "quote": "USDC", "wire": "HYPE/USDC", "pair_index": 150 }, { "symbol": "HFUN-USDC", "base": "HFUN", "quote": "USDC", "wire": "HFUN/USDC", "pair_index": 161 } ], "meta": { "request_id": "req_abc123", "count": 3 } } ``` GET `/v1/hyperliquid/spot/pairs/:symbol` Copy 1 credit Get metadata for a single spot pair, including base/quote tokens and the underlying wire-format identifier. Parameters `symbol` path required Spot symbol in dashed form (e.g., PURR-USDC, HYPE-USDC, HFUN-USDC). Raw @ identifiers are not accepted; use the named pair. Request ``` /v1/hyperliquid/spot/pairs/PURR-USDC ``` Response ``` { "success": true, "data": { "symbol": "PURR-USDC", "base": "PURR", "quote": "USDC", "wire": "PURR/USDC", "pair_index": 107 }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/spot/freshness/:symbol` Copy 1 credit Data freshness for a spot pair: latest timestamps and lag for orderbook, trades, L4, and TWAP. Parameters `symbol` path required Spot symbol (e.g., PURR-USDC, HYPE-USDC). Request ``` /v1/hyperliquid/spot/freshness/PURR-USDC ``` Response ``` { "success": true, "data": { "symbol": "PURR-USDC", "exchange": "hyperliquid_spot", "latest_timestamp": "2026-01-01T12:00:00Z", "lag_ms": 1200, "status": "fresh" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` ### Hyperliquid Spot - Order Book (Build+) GET `/v1/hyperliquid/spot/orderbook/:symbol` Copy 1 credit Get current L2 order book for a Hyperliquid Spot pair. Get current L2 order book for a Hyperliquid Spot pair. Build+ tier required. Live-only from 2026-05-05 (Hyperliquid does not publish historical spot orderbook data). Parameters `symbol` path required Spot symbol (e.g., PURR-USDC, HYPE-USDC). `depth` query Price levels per side (max 20). Request ``` /v1/hyperliquid/spot/orderbook/PURR-USDC?depth=10 ``` Response ``` { "success": true, "data": { "symbol": "PURR-USDC", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50", "spread_bps": "1.19" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/spot/orderbook/:symbol/history` Copy 5 credit s Get historical L2 spot orderbook snapshots with cursor pagination. Get historical L2 spot orderbook snapshots with cursor pagination. Available from 2026-05-05. Build+ tier required. Parameters `symbol` path required Spot symbol (e.g., HYPE-USDC). `start` query required Start timestamp in ms. `end` query required End timestamp in ms. `depth` query Price levels per side (max 20). `cursor` query Pagination cursor from previous response. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/orderbook/HYPE-USDC/history?start=1746489600000&end=1746576000000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "PURR-USDC", "timestamp": "2026-01-01T12:00:00Z", "bids": [ { "px": "42150.50", "sz": "2.5", "n": 5 } ], "asks": [ { "px": "42151.00", "sz": "1.8", "n": 3 } ], "mid_price": "42150.75", "spread": "0.50" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/spot/orderbook/:symbol/l4` Copy 10 credit s Full-depth L4 order book reconstruction with user attribution. Full-depth L4 order book reconstruction with user attribution. Pro+ tier required. Live-only from 2026-05-05. Parameters `symbol` path required Spot symbol (e.g., PURR-USDC). `timestamp` query Reconstruct at this Unix ms timestamp; defaults to latest. Request ``` /v1/hyperliquid/spot/orderbook/PURR-USDC/l4?timestamp=1746576000000 ``` Response ``` { "success": true, "data": { "symbol": "PURR-USDC", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/hyperliquid/spot/orderbook/:symbol/l4/diffs` Copy 3 credit s L4 order-level changes (place, cancel, modify, fill) with user attribution. L4 order-level changes (place, cancel, modify, fill) with user attribution. Pro+ tier required. Live-only from 2026-05-05. Parameters `symbol` path required Spot symbol (e.g., PURR-USDC). `start` query required Start timestamp in ms. `end` query required End timestamp in ms. `cursor` query Pagination cursor. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/orderbook/PURR-USDC/l4/diffs?start=1746489600000&end=1746576000000&limit=500 ``` Response ``` { "success": true, "data": [ { "symbol": "PURR-USDC", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/spot/orderbook/:symbol/l4/history` Copy 3 credit s L4 checkpoint history. L4 checkpoint history. Build+ tier required. Live-only from 2026-05-05. Parameters `symbol` path required Spot symbol (e.g., PURR-USDC). `start` query required Start timestamp in ms. `end` query required End timestamp in ms. `cursor` query Pagination cursor. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/orderbook/PURR-USDC/l4/history?start=1746489600000&end=1746576000000&limit=100 ``` Response ``` { "success": true, "data": [ { "symbol": "PURR-USDC", "timestamp": "2026-03-11T12:00:00Z", "bids": [ { "price": "42150.50", "orders": [ { "order_id": "0xabc", "user_address": "0x1234...abcd", "size": "2.5" } ] } ], "asks": [ { "price": "42151.00", "orders": [ { "order_id": "0xdef", "user_address": "0x5678...efgh", "size": "1.8" } ] } ] } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid Spot - Trades (Build+) GET `/v1/hyperliquid/spot/trades/:symbol` Copy 2 credit s Get spot trade history with verbose schema: builder_address, builder_fee, twap_id, fee_token (open-set: USDC, PURR, HYPE, KHYPE, USOL, ...), and real EVM tx_hash (~69% non-zero for spot, vs all-zero for perps). Get spot trade history with verbose schema: builder_address, builder_fee, twap_id, fee_token (open-set: USDC, PURR, HYPE, KHYPE, USOL, ...), and real EVM tx_hash (~69% non-zero for spot, vs all-zero for perps). Backfilled from 2025-03-22; pre-March 2025 spot history is unrecoverable from any free public archive. Parameters `symbol` path required Spot symbol (e.g., PURR-USDC, HYPE-USDC). `start` query required Start timestamp in ms. `end` query required End timestamp in ms. `cursor` query Pagination cursor. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/trades/PURR-USDC?start=1742601600000&end=1742688000000&limit=500 ``` Response ``` { "success": true, "data": [ { "symbol": "PURR-USDC", "timestamp": "2026-01-01T12:00:00Z", "side": "B", "price": "42150.50", "size": "0.25", "trade_id": 12345678, "direction": "Open Long" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid Spot - Order Lifecycle (Build+) GET `/v1/hyperliquid/spot/orders/:symbol/history` Copy 3 credit s Order lifecycle events (place, cancel, modify, fill) for a spot pair. Order lifecycle events (place, cancel, modify, fill) for a spot pair. Build+ tier required. Live-only from 2026-05-05. Parameters `symbol` path required Spot symbol (e.g., HYPE-USDC). `start` query required Start timestamp in ms. `end` query required End timestamp in ms. `user` query Filter by user wallet address. `cursor` query Pagination cursor. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/orders/HYPE-USDC/history?start=1746489600000&end=1746576000000&limit=200 ``` Response ``` { "success": true, "data": [ { "symbol": "PURR-USDC", "timestamp": "2026-01-01T12:00:00Z", "order_id": "0xabc", "user_address": "0x1234...abcd", "status": "filled", "side": "B", "price": "42150.50", "size": "1.2" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ### Hyperliquid Spot - TWAP (Build+) GET `/v1/hyperliquid/spot/twap/:symbol` Copy 2 credit s TWAP execution events for a spot pair, with parent twap_id, fill schedule, and counter-party attribution. TWAP execution events for a spot pair, with parent twap_id, fill schedule, and counter-party attribution. Build+ tier required. Live-only from 2026-05-05. Parameters `symbol` path required Spot symbol (e.g., HYPE-USDC). `start` query required Start timestamp in ms. `end` query required End timestamp in ms. `cursor` query Pagination cursor. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/twap/HYPE-USDC?start=1746489600000&end=1746576000000&limit=200 ``` Response ``` { "success": true, "data": [ { "coin": "HYPE/USDC", "symbol": "HYPE-USDC", "twap_id": 7732, "user_address": "0x44ad...8b9c", "side": "A", "slice_price": "24.875", "slice_size": "12.3", "timestamp": "2026-05-05T17:13:25.119Z", "parent_total_size": "120.0", "completed_size": "36.9", "status": "progressing" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` GET `/v1/hyperliquid/spot/twap/user/:user` Copy 2 credit s TWAP execution events filtered by user wallet across all spot pairs. TWAP execution events filtered by user wallet across all spot pairs. Build+ tier required. Parameters `user` path required User wallet address (0x...). `start` query Start timestamp in ms. `end` query End timestamp in ms. `cursor` query Pagination cursor. `limit` query Max results (1-1000). Request ``` /v1/hyperliquid/spot/twap/user/0x023a3d058020fb76cca98f01b3c48c8938a22355?limit=100 ``` Response ``` { "success": true, "data": [ { "coin": "HYPE/USDC", "symbol": "HYPE-USDC", "twap_id": 7732, "user_address": "0x44ad...8b9c", "side": "A", "slice_price": "24.875", "slice_size": "12.3", "timestamp": "2026-05-05T17:13:25.119Z", "parent_total_size": "120.0", "completed_size": "36.9", "status": "progressing" } ], "meta": { "request_id": "req_abc123", "count": 1, "next_cursor": "1704067200000_abc123", "has_more": false } } ``` ## Data Quality Freshness, incidents, latency, coverage, and health checks. ### Data Quality GET `/v1/data-quality/status` Copy 0 credit s Get overall system health status and per-exchange status Request ``` /v1/data-quality/status ``` Response ``` { "success": true, "data": { "status": "operational", "updated_at": "2026-01-01T12:00:00Z", "services": [ { "name": "rest_api", "status": "operational" }, { "name": "websocket", "status": "operational" }, { "name": "export_pipeline", "status": "operational" } ] }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/data-quality/coverage` Copy 1 credit Get data coverage summary across all exchanges and data types. Get data coverage summary across all exchanges and data types. Note: May take 30-60 seconds on first request (cached for 5 minutes). Request ``` /v1/data-quality/coverage ``` Response ``` { "success": true, "data": [ { "exchange": "hyperliquid", "symbols": 248, "earliest_available": "2023-04-01T00:00:00Z" }, { "exchange": "lighter", "symbols": 86, "earliest_available": "2025-08-01T00:00:00Z" }, { "exchange": "hyperliquid_hip3", "symbols": 125, "earliest_available": "2026-02-17T00:00:00Z" }, { "exchange": "hyperliquid_spot", "symbols": 294, "earliest_available": "2025-03-22T00:00:00Z" } ], "meta": { "request_id": "req_abc123", "count": 4 } } ``` GET `/v1/data-quality/coverage/:exchange` Copy 1 credit Get detailed coverage for a specific exchange. Get detailed coverage for a specific exchange. Note: May take 30-60 seconds on first request (cached for 5 minutes). Parameters `exchange` path required Exchange name (hyperliquid, lighter, hip3) Request ``` /v1/data-quality/coverage/hyperliquid ``` Response ``` { "success": true, "data": { "exchange": "hyperliquid", "symbols": 248, "data_types": [ "orderbook", "trades", "candles", "funding", "open_interest", "liquidations" ], "earliest_available": "2023-04-01T00:00:00Z" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/data-quality/coverage/:exchange/:symbol` Copy 2 credit s Get symbol-specific coverage with gap detection and empirical data cadence. Get symbol-specific coverage with gap detection and empirical data cadence. Supports time-bounded gap detection via from/to params (default: last 30 days). Historical coverage uses hour-level granularity. Note: May take 30-60 seconds on first request (cached for 1 hour). Parameters `exchange` path required Exchange name (hyperliquid, lighter, hip3) `symbol` path required Trading pair (e.g., BTC, ETH) `from` query Start of gap detection window (Unix ms). Default: now - 30 days `to` query End of gap detection window (Unix ms). Default: now Request ``` /v1/data-quality/coverage/hyperliquid/BTC?from=1704067200000&to=1706745600000 ``` Response ``` { "success": true, "data": { "exchange": "hyperliquid", "symbol": "BTC", "coverage": { "orderbook": { "from": "2023-04-01T00:00:00Z", "to": "2026-01-01T12:00:00Z", "status": "complete" }, "trades": { "from": "2023-04-01T00:00:00Z", "to": "2026-01-01T12:00:00Z", "status": "complete" } } }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/data-quality/incidents` Copy 1 credit List data quality incidents with filtering and pagination Parameters `status` query Filter by status: open, resolved, all (default: all) `severity` query Filter by severity: critical, major, minor `exchange` query Filter by exchange `limit` query Max results (default: 50) `offset` query Pagination offset Request ``` /v1/data-quality/incidents?status=open&limit=10 ``` Response ``` { "success": true, "data": [ { "id": "inc_abc123", "status": "resolved", "severity": "minor", "exchange": "hyperliquid", "started_at": "2026-01-01T10:15:00Z", "resolved_at": "2026-01-01T10:42:00Z" } ], "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/data-quality/incidents/:id` Copy 1 credit Get details for a specific incident Parameters `id` path required Incident ID Request ``` /v1/data-quality/incidents/inc_abc123 ``` Response ``` { "success": true, "data": { "id": "inc_abc123", "status": "resolved", "severity": "minor", "summary": "Delayed order book checkpoints for BTC", "affected": [ { "exchange": "hyperliquid", "symbol": "BTC", "data_type": "orderbook" } ], "started_at": "2026-01-01T10:15:00Z", "resolved_at": "2026-01-01T10:42:00Z" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/data-quality/latency` Copy 1 credit Get current latency metrics for WebSocket, REST API, and data freshness Request ``` /v1/data-quality/latency ``` Response ``` { "success": true, "data": { "rest_p50_ms": 42, "rest_p95_ms": 138, "websocket_p95_ms": 95, "freshness_lag_ms": 1200, "measured_at": "2026-01-01T12:00:00Z" }, "meta": { "request_id": "req_abc123", "count": 1 } } ``` GET `/v1/data-quality/sla` Copy 5 credit s Get SLA compliance metrics for a specific month Parameters `year` query Year (default: current year) `month` query Month 1-12 (default: current month) Request ``` /v1/data-quality/sla?year=2026&month=1 ``` Response ``` { "success": true, "data": { "month": "2026-01", "uptime_percent": 99.98, "incidents": 1, "excluded_minutes": 0 }, "meta": { "request_id": "req_abc123", "count": 1 } } ```