0xarchive
Query historical and real-time crypto market data from 0xArchive across 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 like 'Will BTC be >= X by date Y?') live at /v1/hyperliquid/hip4. Hyperliquid Spot lives at /v1/hyperliquid/spot with 326 authenticated inventory rows (HYPE-USDC, PURR-USDC, AAPL-USDC, ...); Spot candles are served from 2025-03-22T10:50:22Z. Covers route-specific orderbooks, trades, candles, funding rates, open interest, liquidations, outcome markets, spot, TWAP, and data quality. Real-time WebSocket support is channel-specific. HIP-4 trades, L4 events, and settlement events are live; HIP-4 L2 orderbook and outcome-side OI remain available through REST and stored replay while their live bridges are paused. Use in Claude Code, Codex with skills enabled, and SKILL.md-compatible agents when the user asks about crypto market data, order
0xArchiveIO · 已有 AI 审核记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add 0xArchiveIO/0xarchive-skill --skill 0xarchive技能说明
name: 0xarchive version: 1.12.0 description: > Query historical and real-time crypto market data from 0xArchive across 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 like 'Will BTC be >= X by date Y?') live at /v1/hyperliquid/hip4. Hyperliquid Spot lives at /v1/hyperliquid/spot with 326 authenticated inventory rows (HYPE-USDC, PURR-USDC, AAPL-USDC, ...); Spot candles are served from 2025-03-22T10:50:22Z. Covers route-specific orderbooks, trades, candles, funding rates, open interest, liquidations, outcome markets, spot, TWAP, and data quality. Real-time WebSocket support is channel-specific. HIP-4 trades, L4 events, and settlement events are live; HIP-4 L2 orderbook and outcome-side OI remain available through REST and stored replay while their live bridges are paused. Use in Claude Code, Codex with skills enabled, and SKILL.md-compatible agents when the user asks about crypto market data, orderbooks, trades, candles, funding rates, historical prices, real-time streams, prediction-market outcomes, or spot pairs on Hyperliquid, Lighter.xyz, Hyperliquid HIP-3, Hyperliquid HIP-4, or Hyperliquid Spot. allowed-tools: Bash argument-hint: "query, e.g. 'BTC funding rate' or 'HYPE-USDC spot trades last hour'" 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 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 has 326 authenticated inventory rows at /v1/hyperliquid/spot. Data types are route-specific: 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 <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 | /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": "opaque-cursor" // 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}/l |