0xarchive

0xArchive API Skill

Query historical and real-time crypto market data from 0xArchive using curl. 0xArchive exposes two top-level venue APIs: Hyperliquid and Lighter.xyz. HIP-3 builder perps live under the Hyperliquid namespace at /v1/hyperliquid/hip3. HIP-4 outcome markets (binary prediction markets) live at /v1/hyperliquid/hip4. Hyperliquid Spot (294 pairs) lives at /v1/hyperliquid/spot. Data types: orderbooks, trades, candles, funding rates, open interest, liquidations, outcome markets, spot, TWAP, and data quality metrics.

Orderbook depth limits apply to L2 snapshot endpoints only.

Authentication

All endpoints require the x-api-key header. The key is read from $OXARCHIVE_API_KEY.

curl -s -H "x-api-key: $OXARCHIVE_API_KEY" "https://api.0xarchive.io/v1/..."

Venue Scopes & Coin Naming

| Scope | Path prefix | Coin format | Examples | |----------|-------------|-------------|---------| | Hyperliquid | /v1/hyperliquid | UPPERCASE | BTC, ETH, SOL | | Hyperliquid HIP-3 | /v1/hyperliquid/hip3 | Case-sensitive, builder:NAME | km:US500, xyz:GOLD, hyna:BTC, vntl:SPACEX, flx:TSLA, cash:NVDA | | Hyperliquid HIP-4 | /v1/hyperliquid/hip4 | Bare numeric ` (legacy #0 / %230 also accepted) | 0, 1, 10, 11 | | Hyperliquid Spot | /v1/hyperliquid/spot | Dashed canonical BASE-QUOTE | HYPE-USDC, PURR-USDC, AAPL-USDC | | Lighter | /v1/lighter | UPPERCASE | BTC, ETH` |

Hyperliquid and Lighter auto-uppercase the symbol server-side. HIP-3 coin names are passed through as-is. HIP-4 coins encode outcome and side: 0 is outcome 0 / side 0 (YES), 1 is outcome 0 / side 1 (NO), 10 is outcome 1 / side 0, etc. The bare numeric form is canonical; the legacy #0 and %230 forms still work for backward compatibility. Spot symbols are dashed (HYPE-USDC, PURR-USDC, AAPL-USDC); the server resolves the dashed form to the wire format (PURR/USDC, @107) internally, so always use the dashed form.

Timestamps

All timestamps are Unix milliseconds. Use these shell helpers:

NOW=$(( $(date +%s) * 1000 ))
HOUR_AGO=$(( NOW - 3600000 ))
DAY_AGO=$(( NOW - 86400000 ))
WEEK_AGO=$(( NOW - 604800000 ))

Response Format

Every response follows this shape:

{
  "success": true,
  "data": [ ... ],
  "meta": {
    "count": 100,
    "request_id": "uuid",
    "next_cursor": "1706000000000"   // present when more pages exist
  }
}

Endpoint Reference

Hyperliquid (/v1/hyperliquid)

| Endpoint | Params | Notes | |----------|--------|-------| | GET /instruments | -- | List all instruments | | GET /instruments/{symbol} | -- | Single instrument details | | GET /orderbook/{symbol} | timestamp, depth | Latest or at timestamp | | GET /orderbook/{symbol}/history | start, end, limit, cursor, depth | Historical snapshots | | GET /trades/{symbol} | start, end, limit, cursor | Trade history | | GET /candles/{symbol} | start, end, limit, cursor, interval | OHLCV candles | | GET /funding/{symbol}/current | -- | Current funding rate | | GET /funding/{symbol} | start, end, limit, cursor, interval | Funding rate history | | GET /openinterest/{symbol}/current | -- | Current open interest | | GET /openinterest/{symbol} | start, end, limit, cursor, interval | OI history | | GET /liquidations/{symbol} | start, end, limit, cursor | Liquidation events | | GET /liquidations/{symbol}/volume | start, end, limit, cursor, interval | Aggregated liquidation volume (USD) | | GET /liquidations/user/{address} | start, end, limit, cursor, coin | Liquidations for a user | | GET /freshness/{symbol} | -- | Data freshness per data type | | GET /summary/{symbol} | -- | Combined market summary (price, funding, OI, volume, liquidations) | | GET /prices/{symbol} | start, end, limit, cursor, interval | Mark/oracle/mid price history | | GET /orders/{symbol}/history | start, end, user, status, order_type, limit, cursor | Order history with user attribution | | GET /orders/{symbol}/flow | start, end, interval, limit | Order flow aggregation | | GET /orders/{symbol}/tpsl | start, end, user, triggered, limit, cursor | TP/SL order history | | GET /orderbook/{symbol}/l4 | timestamp, depth | L4 orderbook reconstruction | | GET /orderbook/{symbol}/l4/diffs | start, end, limit, cursor | L4 orderbook diffs | | GET /orderbook/{symbol}/l4/history | start, end, limit, cursor | L4 orderbook checkpoints | | GET /orderbook/{symbol}/l2 | timestamp, depth | L2 full-depth orderbook derived from L4 | | GET /orderbook/{symbol}/l2/history | start, end, limit, cursor, depth | L2 full-depth checkpoints | | GET /orderbook/{symbol}/l2/diffs | start, end, limit, cursor | L2 tick-level diffs |

HIP-3 (/v1/hyperliquid/hip3)

Coin names are case-sensitive (e.g., km:US500). All HIP-3 symbols are available on every tier.

| Endpoint | Params | Notes | |----------|--------|-------| | GET /instruments | -- | List HIP-3 instruments | | GET /instruments/{coin} | -- | Single instrument | | GET /orderbook/{coin} | timestamp, depth | All HIP-3 symbols, every tier. | | GET /orderbook/{coin}/history | start, end, limit, cursor, depth | All HIP-3 symbols, every tier. | | GET /trades/{coin} | start, end, limit, cursor | Trade history | | GET /trades/{coin}/recent | limit | Recent trades (no time range needed) | | GET /candles/{coin} | start, end, limit, cursor, interval | OHLCV candles | | GET /funding/{coin}/current | -- | Current funding rate | | GET /funding/{coin} | start, end, limit, cursor, interval | Funding history | | GET /openinterest/{coin}/current | -- | Current OI | | GET /openinterest/{coin} | start, end, limit, cursor, interval | OI history | | GET /liquidations/{coin} | start, end, limit, cursor | Liquidation events | | GET /liquidations/{coin}/volume | start, end, limit, cursor, interval | Aggregated liquidation volume (USD) | | GET /freshness/{coin} | -- | Data freshness per data type | | GET /summary/{coin} | -- | Combined market summary (price, funding, OI) | | GET /prices/{coin} | start, end, limit, cursor, interval | Mark/oracle/mid price history | | GET /orders/{coin}/history | start, end, user, status, order_type, limit, cursor | Order history with user attribution | | GET /orders/{coin}/flow | start, end, interval, limit | Order flow aggregation | | GET /orders/{coin}/tpsl | start, end, user, triggered, limit, cursor | TP/SL order history | | GET /orderbook/{coin}/l4 | timestamp, depth | L4 orderbook reconstruction | | GET /orderbook/{coin}/l4/diffs | start, end, limit, cursor | L4 orderbook diffs | | GET /orderbook/{coin}/l4/history | start, end, limit, cursor | L4 orderbook checkpoints | | GET /orderbook/{coin}/l2 | timestamp, depth | L2 full-depth orderbook derived from L4 | | GET /orderbook/{coin}/l2/history | start, end, limit, cursor, depth | L2 full-depth checkpoints | | GET /orderbook/{coin}/l2/diffs | start, end, limit, cursor | L2 tick-level diffs |

HIP-4 (/v1/hyperliquid/hip4)

Outcome markets are binary prediction markets (e.g. "Will BTC be >= $X by date Y?"). Coin names are bare numerics ` (e.g. 0, 1, 10); the legacy #0 / %230 forms are still accepted. HIP-4 has **no funding rates, no liquidations, and no candles** -- those endpoints do not exist on this venue. The mark_price` field on HIP-4 instruments and prices is an implied probability in the range 0..1, not a USD price.

| Endpoint | Params | Notes | |----------|--------|-------| | GET /outcomes | -- | List all outcome markets (HIP-4 only; not present on other venues) | | GET /outcomes/{outcome_id} | -- | Single outcome market detail (HIP-4 only) | | GET /instruments | -- | List HIP-4 instruments (one per side per outcome) | | GET /instruments/{coin} | -- | Single instrument. Coin is the bare numeric (e.g. 0); legacy %230 also accepted. | | GET /orderbook/{coin} | timestamp, depth | Latest or at timestamp | | GET /orderbook/{coin}/history | start, end, limit, cursor, depth | Historical snapshots | | GET /trades/{coin} | start, end, limit, cursor | Trade history | | GET /trades/{coin}/recent | limit | Recent trades | | GET /openinterest/{coin}/current | -- | Current open interest | | GET /openinterest/{coin} | start, end, limit, cursor, interval | OI history | | GET /freshness/{coin} | -- | Data freshness per data type | | GET /summary/{coin} | -- | Combined market summary (implied probability + OI; no funding) | | GET /prices/{coin} | start, end, limit, cursor, interval | Implied-probability history (mark/oracle/mid in 0..1) | | GET /orders/{coin}/history | start, end, user, status, order_type, limit, cursor | Order history | | GET /orders/{coin}/flow | start, end, interval, limit | Order flow aggregation | | GET /orders/{coin}/tpsl | start, end, user, triggered, limit, cursor | TP/SL order history | | GET /orderbook/{coin}/l4 | timestamp, depth | L4 orderbook reconstruction | | GET /orderbook/{coin}/l4/diffs | start, end, limit, cursor | L4 orderbook diffs | | GET /orderbook/{coin}/l4/history | start, end, limit, cursor | L4 orderbook checkpoints | | GET /orderbook/{coin}/l2 | timestamp, depth | L2 full-depth orderbook derived from L4 | | GET /orderbook/{coin}/l2/history | start, end, limit, cursor, depth | L2 full-depth checkpoints | | GET /orderbook/{coin}/l2/diffs | start, end, limit, cursor | L2 tick-level diffs |

Hyperliquid Spot (/v1/hyperliquid/spot)

294 spot pairs on Hyperliquid (HYPE-USDC, PURR-USDC, AAPL-USDC, ...). Symbols are dashed canonical (BASE-QUOTE); the server resolves to the wire format (PURR/USDC, @107) internally. Spot has no funding rates, no open interest, no liquidations, and no candles -- those are perp-only constructs and the endpoints do not exist on this venue. Use spot for pair discovery, current and historical L2 orderbooks, fills, L4 reconstruction, order lifecycle, and TWAP execution status.

Coverage:

• Trades: backfilled from 2025-03-22 (~284M rows). Pre-March 2025 spot fills are not available (no public archive existed).
• Orderbook, L4, TWAP: live-forward from 2026-05-05. No historical orderbook data prior to that date.

| Endpoint | Params | Notes | |----------|--------|-------| | GET /pairs | -- | List all 294 spot pairs | | GET /pairs/{symbol} | -- | Single pair detail (e.g. HYPE-USDC) | | GET /orderbook/{symbol} | timestamp, depth | Current L2 orderbook (live from 2026-05-05) | | GET /orderbook/{symbol}/history | start, end, limit, cursor, depth | L2 history window (from 2026-05-05) | | GET /orderbook/{symbol}/l4 | timestamp, depth | Point-in-time L4 reconstruction | | GET /orderbook/{symbol}/l4/diffs | start, end, limit, cursor | Raw L4 diffs | | GET /orderbook/{symbol}/l4/history | start, end, limit, cursor | L4 checkpoints | | GET /trades/{symbol} | start, end, limit, cursor, user | Spot trades. Pass user to filter to a wallet's fills. Backfilled to 2025-03-22. | | GET /orders/{symbol}/history | start, end, user, status, order_type, limit, cursor | Spot order lifecycle | | GET /twap/{symbol} | start, end, limit, cursor | TWAP execution statuses for a symbol | | GET /twap/user/{user} | start, end, limit, cursor | TWAP execution statuses for a wallet | | GET /freshness/{symbol} | -- | Data freshness per data type |

Lighter (/v1/lighter)

Same data types as Hyperliquid except: no liquidations. Adds granularity on orderbook history and /recent trades.

| Endpoint | Params | Notes | |----------|--------|-------| | GET /instruments | -- | List Lighter instruments | | GET /instruments/{symbol} | -- | Single instrument | | GET /orderbook/{symbol} | timestamp, depth | Latest or at timestamp | | GET /orderbook/{symbol}/history | start, end, limit, cursor, depth, granularity | Default granularity: checkpoint | | GET /trades/{symbol} | start, end, limit, cursor | Trade history | | GET /trades/{symbol}/recent | limit | Recent trades (no time range needed) | | GET /candles/{symbol} | start, end, limit, cursor, interval | OHLCV candles | | GET /funding/{symbol}/current | -- | Current funding rate | | GET /funding/{symbol} | start, end, limit, cursor, interval | Funding history | | GET /openinterest/{symbol}/current | -- | Current OI | | GET /openinterest/{symbol} | start, end, limit, cursor, interval | OI history | | GET /freshness/{symbol} | -- | Data freshness per data type | | GET /summary/{symbol} | -- | Combined market summary (price, funding, OI) | | GET /prices/{symbol} | start, end, limit, cursor, interval | Mark/oracle price history | | GET /l3orderbook/{symbol} | timestamp, depth, account | L3 order-level orderbook | | GET /l3orderbook/{symbol}/history | start, end, limit, cursor, granularity, account | Historical L3 snapshots |

Data Quality (/v1/data-quality)

| Endpoint | Params | Notes | |----------|--------|-------| | GET /status | -- | System health status | | GET /coverage | -- | Coverage summary across venue APIs | | GET /coverage/{exchange} | -- | Coverage for one venue scope | | GET /coverage/{exchange}/{symbol} | from, to | Symbol-level coverage + gaps | | GET /incidents | status, exchange, since, limit, offset | List incidents | | GET /incidents/{id} | -- | Single incident | | GET /latency | -- | Ingestion latency metrics | | GET /sla | year, month | SLA compliance report |

WebSocket Channels

Real-time + historical-replay channels available via WebSocket (wss://api.0xarchive.io/ws?apiKey=KEY). WebSocket access (including all L4 channels) is available on every tier, starting with Free (10 subscriptions / 2 connections / 10x replay).

Trades + liquidations (realtime + replay):

| Channel | Notes | |---------|-------| | trades | Hyperliquid trades. One row per side per fill. | | hip3_trades | HIP-3 trades. | | hip4_trades | HIP-4 trades. | | spot_trades | Hyperliquid Spot trades. Symbol is dashed (HYPE-USDC). | | lighter_trades | Lighter trades. | | liquidations | Hyperliquid liquidations. Each event is a fill row with is_liquidation: true (same shape as trades). | | hip3_liquidations | HIP-3 liquidations. Each event is a fill row with is_liquidation: true (same shape as hip3_trades). |

Orderbook + open interest (realtime + replay):

| Channel | Notes | |---------|-------| | orderbook, hip3_orderbook, hip4_orderbook, lighter_orderbook | L2 orderbook updates (~1.2 sec resolution) | | spot_orderbook | Hyperliquid Spot L2 orderbook updates. Symbol is dashed (HYPE-USDC). | | hip4_open_interest | HIP-4 per-side OI snapshots |

Order-level (realtime only):

| Channel | Notes | |---------|-------| | l4_diffs | Hyperliquid L4 orderbook diffs with user attribution | | l4_orders | Hyperliquid order lifecycle events | | hip3_l4_diffs | HIP-3 L4 orderbook diffs | | hip3_l4_orders | HIP-3 order lifecycle events | | hip4_l4_diffs | HIP-4 L4 orderbook diffs | | hip4_l4_orders | HIP-4 order lifecycle events | | `spot_l

…

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: 0xArchiveIO
• Source: 0xArchiveIO/0xarchive-skill
• License: MIT
• Homepage: https://www.0xarchive.io/github-skill

Install and usage instructions live in the source repository linked above.