0xarchive

1# 0xArchive API Skill
2
3Query historical and real-time crypto market data from **0xArchive** using `curl`. Three exchanges are supported: **Hyperliquid** (perps DEX), **Lighter.xyz** (order-book DEX), and **HIP-3** (Hyperliquid builder perps). Data types: orderbooks, trades, candles, funding rates, open interest, liquidations, and data quality metrics.
4
5## Authentication
6
7All endpoints require the `x-api-key` header. The key is read from `$OXARCHIVE_API_KEY`.
8
9```bash
10curl -s -H "x-api-key: $OXARCHIVE_API_KEY" "https://api.0xarchive.io/v1/..."
11```
12
13## Exchanges & Coin Naming
14
15| Exchange | Path prefix | Coin format | Examples |
16|----------|-------------|-------------|---------|
17| Hyperliquid | `/v1/hyperliquid` | UPPERCASE | `BTC`, `ETH`, `SOL` |
18| HIP-3 | `/v1/hyperliquid/hip3` | Case-sensitive, `builder:NAME` | `km:US500`, `xyz:GOLD`, `hyna:BTC`, `vntl:SPACEX`, `flx:TSLA`, `cash:NVDA` |
19| Lighter | `/v1/lighter` | UPPERCASE | `BTC`, `ETH` |
20
21Hyperliquid and Lighter auto-uppercase the symbol server-side. HIP-3 coin names are passed through as-is.
22
23## Timestamps
24
25All timestamps are **Unix milliseconds**. Use these shell helpers:
26
27```bash
28NOW=$(( $(date +%s) * 1000 ))
29HOUR_AGO=$(( NOW - 3600000 ))
30DAY_AGO=$(( NOW - 86400000 ))
31WEEK_AGO=$(( NOW - 604800000 ))
32```
33
34## Response Format
35
36Every response follows this shape:
37
38```json
39{
40  "success": true,
41  "data": [ ... ],
42  "meta": {
43    "count": 100,
44    "request_id": "uuid",
45…