/query

name: 0xarchive
version: 1.17.0
description: >
  Query historical and real-time crypto market data from 0xArchive across two venues: Hyperliquid and Lighter.
  Lighter has two deployments: mainnet at /v1/lighter and Robinhood Chain at /v1/rh-lighter (USDG-quoted, e.g. BTC, AAPL-USDG).
  Hyperliquid includes HIP-3 builder perps (/v1/hyperliquid/hip3), HIP-4 outcome markets (/v1/hyperliquid/hip4), and Spot (/v1/hyperliquid/spot, e.g. HYPE-USDC).
  Covers orderbooks, trades, candles, funding, open interest, liquidations, account positions, outcome markets, TWAP, CVD, breadth, trade intent, USDC flows, positioning, webhooks, and data quality; data types are route-specific.
  WebSocket support is channel-specific and GET /v1/capabilities lists it per venue and data type: Lighter orderbook, trades, open interest, and funding stream live on both deployments; Lighter candles and L3 are replay-only; L4 channels replay on Hyperliquid core, HIP-3, HIP-4, and Spot.
  Use in Claude Code, Codex, and SKILL.md-compatible agents for market data, orderbooks, trades, candles, funding, prices, positions, real-time streams, prediction markets, or spot pairs on Hyperliquid, HIP-3, HIP-4, Hyperliquid Spot, Lighter, or Lighter on Robinhood Chain.
allowed-tools: Bash
argument-hint: "query, e.g. 'BTC funding rate', 'AAPL-USDG orderbook on Robinhood Chain', or 'positions for wallet 0x...'"
metadata: {"openclaw":{"requires":{"env":["OXARCHIVE_API_KEY"]},"primaryEnv":"OXARCHIVE_API_KEY"}}

0xArchive API Skill

Query historical and real-time crypto market data from **0xArchive** using `curl`. 0xArchive covers two venues: **Hyperliquid** and **Lighter**. **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** lives at `/v1/hyperliquid/spot`. Lighter has two deployments: mainnet at `/v1/lighter` and **Robinhood Chain** at `/v1/rh-lighter`. Robinhood Chain is a second deployment of Lighter, not a third venue. Data types are route-specific: orderbooks, trades, candles, funding rates, open interest, liquidations, account positions, outcome markets, spot, TWAP, and data quality metrics.

Orderbook depth limits apply to L2 snapshot endpoints only.

Authentication and API Version

Market-data endpoints require the `x-api-key` header. The key is read from `$OXARCHIVE_API_KEY`. Also send `0xArchive-Version: 2026-10-01` on every request; every example in this skill does.

curl -s -H "x-api-key: $OXARCHIVE_API_KEY" -H "0xArchive-Version: 2026-10-01" "https://api.0xarchive.io/v1/..."

The version header selects the current response contract, and responses echo it in their own `0xArchive-Version` header. Requests without it keep the earlier shapes, which remain supported. With it:

• Error bodies use the current `error_code` names (see [Error Handling](#error-handling)).
• Time fields that are otherwise integer milliseconds become RFC 3339 strings with an integer companion ending `_ms`: resting-order `timestamp` in L4 snapshots (adds `timestamp_ms`), CVD buckets, HIP-3 oracle prices, Lighter and Robinhood Chain liquidations and liquidation volume, and levels and trigger-levels `snapshot_ts` (adds `snapshot_ts_ms`).
• Data quality routes and `/v1/symbols` return the standard `{success, data, meta}` envelope.

On WebSocket, add `version=2026-10-01` to the connection URL: `wss://api.0xarchive.io/ws?apiKey=KEY&version=2026-10-01`. The `subscribed` and `replay_started` acks echo the version, and Lighter and Robinhood Chain replay rows use the same shapes as their live messages.

Capabilities

`GET /v1/capabilities` lists what each venue offers. It is public (no API key) and costs no credits. It returns one row per venue and data type:

| Field | Meaning | |-------|---------| | `venue` | `hyperliquid`, `hip3`, `hip4`, `spot`, `lighter`, or `rh-lighter` | | `datatype` | For example `trades`, `l2_orderbook`, `l2_full_depth`, `l4_diffs`, `l4_orders`, `candles`, `funding`, `oi` | | `rest_routes` | REST routes that serve it | | `ws_channels` | WebSocket channels that carry it | | `live`, `replay` | Whether its channels stream live, and whether they replay history | | `available_from` | RFC 3339 start of served history, or `null` when not tracked | | `cadence` | `event`, `snapshot`, `sample`, `interval`, or `reference` | | `page_limit` | Maximum `limit` for the route family | | `intervals` | Accepted `interval` values | | `notes` | Caveats, such as policy floors and bulk single-channel replay |

Check it before calling a route or channel you have not used:

curl -s "https://api.0xarchive.io/v1/capabilities" \
  | jq '.data[] | select(.venue == "hip3") | {datatype, live, replay, available_from, page_limit}'

A venue that does not offer a data type answers 404 `unsupported_for_venue`, naming the venues and routes that do. Per-symbol coverage comes from `GET /v1/symbols` and `GET /v1/data-quality/coverage/{exchange}/{symbol}`.

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` | `xyz:SP500`, `xyz:GOLD`, `hyna:BTC`, `vntl:SPACEX`, `flx:TSLA`, `cash:NVDA` | | Hyperliquid HIP-4 | `/v1/hyperliquid/hip4` | Bare numeric `<10*outcome_id + side>` (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 (mainnet) | `/v1/lighter` | UPPERCASE | `BTC`, `ETH` | | Lighter on Robinhood Chain | `/v1/rh-lighter` | UPPERCASE perps; dashed `BASE-USDG` spot | `BTC`, `ETH`, `AAPL-USDG` |

Hyperliquid and both Lighter deployments auto-uppercase the symbol server-s