{"_id":"@0xarchive/cli","_rev":"7-dbb3cd2aac7fa87dc66164313feb58e3","name":"@0xarchive/cli","dist-tags":{"latest":"1.7.0"},"versions":{"1.0.0":{"name":"@0xarchive/cli","version":"1.0.0","keywords":["0xarchive","cli","hyperliquid","lighter","orderbook","trades","historical-data","crypto"],"author":{"name":"0xarchive"},"license":"MIT","_id":"@0xarchive/cli@1.0.0","maintainers":[{"name":"fmenace","email":"app.fantom.menace@gmail.com"}],"homepage":"https://0xarchive.io/docs/sdks","bugs":{"url":"https://github.com/0xArchiveIO/sdk-typescript/issues"},"bin":{"oxa":"dist/cli.js"},"dist":{"shasum":"58ad68c518ef330842003a3c1f937d96b89f92c1","tarball":"https://registry.npmjs.org/@0xarchive/cli/-/cli-1.0.0.tgz","fileCount":4,"integrity":"sha512-q32oi+U24VMk+PoQwsfRjLbo718GCFcqOosM2CBZTHtLsp7DTydkzBmsTcnnexvaqt8P+PyETdvSmjWeS0YSnA==","signatures":[{"sig":"MEYCIQCyln9+iB1yqZEwS/g1DkiJ/3lkzxCjzAg1XvaLgGXCsgIhAM4oICYr5ZTi/jzDvjHsXsWKFO1MwAPh98CTexsp1ccj","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":57070},"type":"module","engines":{"node":">=18"},"gitHead":"af10ec0506940ea05837038fb862d6ea95ccd88b","scripts":{"dev":"tsx src/cli.ts","test":"vitest run","build":"tsup","typecheck":"tsc --noEmit","test:watch":"vitest","prepublishOnly":"npm run build"},"_npmUser":{"name":"fmenace","email":"app.fantom.menace@gmail.com"},"repository":{"url":"git+https://github.com/0xArchiveIO/sdk-typescript.git","type":"git"},"_npmVersion":"10.9.2","description":"CLI for querying historical crypto market data from 0xArchive","directories":{},"_nodeVersion":"22.16.0","dependencies":{"chalk":"^5.4.0","commander":"^13.0.0","@0xarchive/sdk":"^0.9.2"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.0.0","tsup":"^8.0.0","vitest":"^2.0.0","typescript":"^5.4.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.0.0_1772406695525_0.15316133954346478","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@0xarchive/cli","version":"1.1.0","keywords":["0xarchive","cli","hyperliquid","lighter","orderbook","trades","historical-data","crypto"],"author":{"name":"0xarchive"},"license":"MIT","_id":"@0xarchive/cli@1.1.0","maintainers":[{"name":"fmenace","email":"app.fantom.menace@gmail.com"}],"homepage":"https://0xarchive.io/docs/sdks","bugs":{"url":"https://github.com/0xArchiveIO/sdk-typescript/issues"},"bin":{"oxa":"dist/cli.js"},"dist":{"shasum":"e99d6d89987094520b8263d882623d61d0faed7a","tarball":"https://registry.npmjs.org/@0xarchive/cli/-/cli-1.1.0.tgz","fileCount":4,"integrity":"sha512-tUi2DmPKwuRDiqIqwRQSEX4MoJSPgjK+i2+/fhYO3InrCf5RDIjRBYlgqKxpRvnmprA/niCRKksl5fXVlpEk6Q==","signatures":[{"sig":"MEYCIQDMa4pKTFuCUDDdbJNu9cl+obuI/mHyxoXcao6azQUElAIhAJYzTluCJm815Xvq2Z33nRMnjpA8LrpaByMjleGT8tXH","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":130939},"type":"module","engines":{"node":">=18"},"gitHead":"bfdd0f9648ca1a873687a49d0a18391d9812dff6","scripts":{"dev":"tsx src/cli.ts","test":"vitest run","build":"tsup","typecheck":"tsc --noEmit","test:watch":"vitest","prepublishOnly":"npm run build"},"_npmUser":{"name":"fmenace","email":"app.fantom.menace@gmail.com"},"repository":{"url":"git+https://github.com/0xArchiveIO/sdk-typescript.git","type":"git"},"_npmVersion":"10.9.2","description":"CLI for querying historical crypto market data from 0xArchive","directories":{},"_nodeVersion":"22.16.0","dependencies":{"chalk":"^5.4.0","commander":"^13.0.0","@0xarchive/sdk":"^0.9.2"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.0.0","tsup":"^8.0.0","vitest":"^2.0.0","typescript":"^5.4.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.1.0_1772408255800_0.4706654453750443","host":"s3://npm-registry-packages-npm-production"}},"1.2.0":{"name":"@0xarchive/cli","version":"1.2.0","keywords":["0xarchive","cli","hyperliquid","lighter","orderbook","trades","historical-data","crypto"],"author":{"name":"0xarchive"},"license":"MIT","_id":"@0xarchive/cli@1.2.0","maintainers":[{"name":"fmenace","email":"app.fantom.menace@gmail.com"}],"homepage":"https://0xarchive.io/docs/sdks","bugs":{"url":"https://github.com/0xArchiveIO/sdk-typescript/issues"},"bin":{"oxa":"dist/cli.js"},"dist":{"shasum":"c1c577af5d6860818e7c02ae5415ae1650b5cf1c","tarball":"https://registry.npmjs.org/@0xarchive/cli/-/cli-1.2.0.tgz","fileCount":4,"integrity":"sha512-4XUaHK/yVTeAiTR6b1k7B9frYJRD5EmfkHN1dIvSCZAjn517zpWyxwPIX0R14J+zxh+8QKJ1tjvCKVRU7dN0Mw==","signatures":[{"sig":"MEQCIHFeuTtmOl9Jf1Le9Ljuei8Opr8ANxDxzB8e0e2lc3X5AiBbHwuUG5dTu8CNbsPSLVUvzykMHAHON4xv8VQfkijflQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":226172},"type":"module","engines":{"node":">=18"},"gitHead":"b14e71c1ebb111282747777d9ceaff605b37aed1","scripts":{"dev":"tsx src/cli.ts","test":"vitest run","build":"tsup","typecheck":"tsc --noEmit","test:watch":"vitest","prepublishOnly":"npm run build"},"_npmUser":{"name":"fmenace","email":"app.fantom.menace@gmail.com"},"repository":{"url":"git+https://github.com/0xArchiveIO/sdk-typescript.git","type":"git"},"_npmVersion":"10.9.2","description":"CLI for querying historical crypto market data from 0xArchive","directories":{},"_nodeVersion":"22.16.0","dependencies":{"chalk":"^5.4.0","commander":"^13.0.0","@0xarchive/sdk":"^1.2.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.0.0","tsup":"^8.0.0","vitest":"^2.0.0","typescript":"^5.4.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.2.0_1773856634121_0.7535868831036268","host":"s3://npm-registry-packages-npm-production"}},"1.3.0":{"name":"@0xarchive/cli","version":"1.3.0","keywords":["0xarchive","cli","hyperliquid","lighter","orderbook","trades","historical-data","crypto"],"author":{"name":"0xarchive"},"license":"MIT","_id":"@0xarchive/cli@1.3.0","maintainers":[{"name":"fmenace","email":"app.fantom.menace@gmail.com"}],"homepage":"https://0xarchive.io/docs/sdks","bugs":{"url":"https://github.com/0xArchiveIO/sdk-typescript/issues"},"bin":{"oxa":"dist/cli.js"},"dist":{"shasum":"a04f21519f6d17bd6ca1d36fd99e8c293e5d7a13","tarball":"https://registry.npmjs.org/@0xarchive/cli/-/cli-1.3.0.tgz","fileCount":4,"integrity":"sha512-gQW4by5WvgHK1shRvGNUjrx9o8tRH9SU/vrpBL0Kds1k9vaciwo2cyejRLuq/sKGv1V+AevuGkqPTWF+KzQFzg==","signatures":[{"sig":"MEYCIQCaMnlJX14ck68VXWegNlSEJ7oO42QOLWGc+dkupBUCAQIhAK4nTdtvVjhDOFqTRRohEdLAKGcGsd0ZrlCsUOtVtFGT","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":250668},"type":"module","engines":{"node":">=18"},"gitHead":"2c08cc6568deb0d54f6b8a53dd83d65d81a833be","scripts":{"dev":"tsx src/cli.ts","test":"vitest run","build":"tsup","typecheck":"tsc --noEmit","test:watch":"vitest","prepublishOnly":"npm run build"},"_npmUser":{"name":"fmenace","email":"app.fantom.menace@gmail.com"},"repository":{"url":"git+https://github.com/0xArchiveIO/sdk-typescript.git","type":"git"},"_npmVersion":"10.9.4","description":"CLI for querying historical crypto market data from 0xArchive","directories":{},"_nodeVersion":"22.22.0","dependencies":{"chalk":"^5.4.0","commander":"^13.0.0","@0xarchive/sdk":"^1.3.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.0.0","tsup":"^8.0.0","vitest":"^2.0.0","typescript":"^5.4.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.3.0_1775324109339_0.4345343453892343","host":"s3://npm-registry-packages-npm-production"}},"1.4.0":{"name":"@0xarchive/cli","version":"1.4.0","keywords":["0xarchive","cli","hyperliquid","lighter","orderbook","trades","historical-data","crypto"],"author":{"name":"0xarchive"},"license":"MIT","_id":"@0xarchive/cli@1.4.0","maintainers":[{"name":"fmenace","email":"app.fantom.menace@gmail.com"}],"homepage":"https://0xarchive.io/docs/sdks","bugs":{"url":"https://github.com/0xArchiveIO/sdk-typescript/issues"},"bin":{"oxa":"dist/cli.js"},"dist":{"shasum":"bf037eacb0a042bd36d8ba0c0d5296a4ccb35142","tarball":"https://registry.npmjs.org/@0xarchive/cli/-/cli-1.4.0.tgz","fileCount":4,"integrity":"sha512-h7kStPZpopsfs6rj6vtWgpApbuQR8SjICt4hSE0TimudWFjLfWjA6IKtWAwS2n7bp8zWmeXWLIhMjlrg/oGgqw==","signatures":[{"sig":"MEYCIQDAMi79u0olBOz3KaGsyMTeUX2DDqBF/QvT2hTHTT+FjwIhAOgO/1sLURomXnVz61LBFzT8O7QkWI53zaRl+07V9u7r","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":250668},"type":"module","engines":{"node":">=18"},"gitHead":"4382793322ca31cecc494e8f51d5d9c091cc87d7","scripts":{"dev":"tsx src/cli.ts","test":"vitest run","build":"tsup","typecheck":"tsc --noEmit","test:watch":"vitest","prepublishOnly":"npm run build"},"_npmUser":{"name":"fmenace","email":"app.fantom.menace@gmail.com"},"repository":{"url":"git+https://github.com/0xArchiveIO/sdk-typescript.git","type":"git"},"_npmVersion":"10.9.4","description":"CLI for querying historical crypto market data from 0xArchive","directories":{},"_nodeVersion":"22.22.0","dependencies":{"chalk":"^5.4.0","commander":"^13.0.0","@0xarchive/sdk":"^1.4.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.0.0","tsup":"^8.0.0","vitest":"^2.0.0","typescript":"^5.4.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.4.0_1776471341740_0.3177273003141463","host":"s3://npm-registry-packages-npm-production"}},"1.6.0":{"name":"@0xarchive/cli","version":"1.6.0","keywords":["0xarchive","cli","market-data","hyperliquid","lighterxyz","orderbook","trades","replay","agents","historical-data","crypto"],"author":{"name":"0xarchive"},"license":"MIT","_id":"@0xarchive/cli@1.6.0","maintainers":[{"name":"fmenace","email":"app.fantom.menace@gmail.com"}],"homepage":"https://www.0xarchive.io/github-cli","bugs":{"url":"https://github.com/0xArchiveIO/0xarchive-cli/issues"},"bin":{"oxa":"dist/cli.js"},"dist":{"shasum":"eb642cf7f5dcedd518ad4f6f1c4dedd96dc9a5c5","tarball":"https://registry.npmjs.org/@0xarchive/cli/-/cli-1.6.0.tgz","fileCount":5,"integrity":"sha512-5bTgpejX9LjOX0m88qVD7pduYrkXHqrHx1ibE3VgfZasZp56v65kCDuMrm690s5xJz4VdmNskOpMUjVh7l9LnQ==","signatures":[{"sig":"MEQCIBxYfXM/w0C3XFA0PQbwhpZM7Auo2QIBeqsO1vxZ6VzxAiBZ1kaupJ8JNCxVQluslCp7Fk5fXK84RWEYuBblKbT/Ng==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":343676},"type":"module","engines":{"node":">=18"},"gitHead":"dd41cd7005f7224c4d2dc3188e2c438510ca9e93","scripts":{"dev":"tsx src/cli.ts","test":"vitest run","build":"tsup","typecheck":"tsc --noEmit","test:watch":"vitest","prepublishOnly":"npm run build"},"_npmUser":{"name":"fmenace","email":"app.fantom.menace@gmail.com"},"repository":{"url":"git+https://github.com/0xArchiveIO/0xarchive-cli.git","type":"git"},"_npmVersion":"10.9.2","description":"Terminal-first 0xArchive client for Hyperliquid and Lighter.xyz market data, including Hyperliquid HIP-3 and HIP-4","directories":{},"_nodeVersion":"22.16.0","dependencies":{"chalk":"^5.4.0","commander":"^13.0.0","@0xarchive/sdk":"^1.4.0"},"_hasShrinkwrap":false,"devDependencies":{"tsx":"^4.0.0","tsup":"^8.0.0","vitest":"^2.0.0","typescript":"^5.4.0","@types/node":"^22.0.0"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.6.0_1778004139748_0.6846599847520551","host":"s3://npm-registry-packages-npm-production"}},"1.7.0":{"name":"@0xarchive/cli","version":"1.7.0","description":"Terminal-first 0xArchive client for Hyperliquid and Lighter.xyz market data, including Hyperliquid HIP-3, HIP-4, and Spot","type":"module","bin":{"oxa":"dist/cli.js"},"scripts":{"build":"tsup","dev":"tsx src/cli.ts","typecheck":"tsc --noEmit","test":"vitest run","test:watch":"vitest","prepublishOnly":"npm run build"},"keywords":["0xarchive","cli","market-data","hyperliquid","lighterxyz","orderbook","trades","replay","agents","historical-data","crypto"],"author":{"name":"0xarchive"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/0xArchiveIO/0xarchive-cli.git"},"homepage":"https://www.0xarchive.io/github-cli","bugs":{"url":"https://github.com/0xArchiveIO/0xarchive-cli/issues"},"engines":{"node":">=18"},"dependencies":{"@0xarchive/sdk":"^1.7.0","commander":"^13.0.0","chalk":"^5.4.0"},"devDependencies":{"@types/node":"^22.0.0","tsup":"^8.0.0","tsx":"^4.0.0","typescript":"^5.4.0","vitest":"^2.0.0"},"_id":"@0xarchive/cli@1.7.0","gitHead":"e3e7b9627419b83d7962cfeb3a6fcbfed7ffff74","_nodeVersion":"22.16.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-nHzyTs8NeoKjH1xwfiafF9KiDuaDw8YAiYo6Biy7vO9BqZKYyqrlyxj+ghT3X25z7bh9hO7vB9GBOVWgrd/xHA==","shasum":"b5a0e4ccf2956427069a14734460a6c95d229243","tarball":"https://registry.npmjs.org/@0xarchive/cli/-/cli-1.7.0.tgz","fileCount":5,"unpackedSize":411325,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIHUHXoe/kau43uXAB7ZxUwrDpT83V9d+Ztn3+eYkvNUPAiEAwA1T4hKXV9TVhT4c7xZ+9FluqT/xf64U0T9UdFbaWsQ="}]},"_npmUser":{"name":"fmenace","email":"app.fantom.menace@gmail.com"},"directories":{},"maintainers":[{"name":"fmenace","email":"app.fantom.menace@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cli_1.7.0_1778206784189_0.44232965885375797"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-01T23:11:35.347Z","modified":"2026-05-08T02:19:44.482Z","1.0.0":"2026-03-01T23:11:35.667Z","1.1.0":"2026-03-01T23:37:35.943Z","1.2.0":"2026-03-18T17:57:14.267Z","1.3.0":"2026-04-04T17:35:09.539Z","1.4.0":"2026-04-18T00:15:41.914Z","1.6.0":"2026-05-05T18:02:19.914Z","1.7.0":"2026-05-08T02:19:44.343Z"},"bugs":{"url":"https://github.com/0xArchiveIO/0xarchive-cli/issues"},"author":{"name":"0xarchive"},"license":"MIT","homepage":"https://www.0xarchive.io/github-cli","keywords":["0xarchive","cli","market-data","hyperliquid","lighterxyz","orderbook","trades","replay","agents","historical-data","crypto"],"repository":{"type":"git","url":"git+https://github.com/0xArchiveIO/0xarchive-cli.git"},"description":"Terminal-first 0xArchive client for Hyperliquid and Lighter.xyz market data, including Hyperliquid HIP-3, HIP-4, and Spot","maintainers":[{"name":"fmenace","email":"app.fantom.menace@gmail.com"}],"readme":"# @0xarchive/cli\n\nTerminal-first access to 0xArchive market data.\n\n0xArchive is granular market data infrastructure for Hyperliquid and Lighter.xyz. HIP-3 builder perps, HIP-4 outcome markets, and Hyperliquid Spot live under the Hyperliquid namespace; the CLI exposes `--exchange hip3`, `--exchange hip4`, and the `oxa spot` group as convenience scopes for those markets.\n\nUse `oxa` when the job starts in a terminal, script, CI task, notebook setup step, Claude Code session, GPT Codex session, or another coding-agent shell. Both coding agents can start here with `oxa auth test` and one market-data request before expanding into SDKs, MCP, skills, or Data Catalog exports. The command set covers order books, trades, candles, funding, open interest, liquidations, prices, freshness, Lighter L3, Hyperliquid/HIP-3 L4 routes, HIP-4 outcome markets, and Hyperliquid Spot.\n\n## Install\n\n```bash\nnpm install -g @0xarchive/cli\n```\n\nOr run without installing:\n\n```bash\nnpx @0xarchive/cli auth test --exchange hyperliquid --symbol BTC\n```\n\n## First Request\n\n```bash\n# Create a free account, then copy an API key:\n# https://www.0xarchive.io/signup\nexport OXA_API_KEY=\"0xa_your_api_key\"\n\n# Verify your key works\noxa auth test\n\n# Fetch the current Hyperliquid BTC order book\noxa orderbook get --exchange hyperliquid --symbol BTC --format pretty\n\n# Fetch recent Lighter trades\noxa trades fetch --exchange lighter --symbol BTC --limit 50\n\n# Fetch Hyperliquid HIP-3 builder-perp candles\noxa candles --exchange hip3 --symbol km:US500 \\\n  --start 2026-02-28T00:00:00Z --end 2026-03-01T00:00:00Z --interval 1h\n\n# List active HIP-4 outcome markets, then inspect one\noxa hip4 outcomes list --settled false\noxa hip4 outcomes get 0\n\n# Pull the current HIP-4 orderbook for outcome 0 / side 0\noxa hip4 orderbook get 0\n\n# List Hyperliquid Spot pairs and inspect one\noxa spot pairs\noxa spot pair HYPE-USDC\n\n# Stream live Hyperliquid liquidations (Build+ tier; requires Node 22+)\noxa stream liquidations BTC\n```\n\n## Choose Your Next Path\n\n- First authenticated route: [Quick Start](https://www.0xarchive.io/docs/quick-start)\n- Full CLI guide: [CLI docs](https://www.0xarchive.io/docs/cli)\n- Claude Code, GPT Codex, and coding-agent workflows: [AI Clients](https://www.0xarchive.io/docs/ai-clients)\n- File-based pulls: [Data Catalog](https://www.0xarchive.io/data)\n- Plans and limits: [Pricing](https://www.0xarchive.io/pricing)\n- Machine-readable docs: [llms.txt](https://www.0xarchive.io/llms.txt) and [OpenAPI](https://www.0xarchive.io/openapi.json)\n\n## Venue Scopes\n\n| Scope | Flag | Symbols |\n| --- | --- | --- |\n| Hyperliquid | `--exchange hyperliquid` | `BTC`, `ETH`, `SOL`, etc. |\n| Lighter.xyz | `--exchange lighter` | `BTC`, `ETH`, etc. |\n| Hyperliquid HIP-3 | `--exchange hip3` | `km:US500`, `xyz:XYZ100`, etc. Case-sensitive. |\n| Hyperliquid HIP-4 | `--exchange hip4` or `oxa hip4 ...` | Bare numerics: `0`, `1`, `42`. Legacy `#0` / `%230` forms still work. `mark_price` is implied probability (0..1), not USD. No funding, liquidations, or candles. |\n| Hyperliquid Spot | `oxa spot ...` | Dashed canonical: `HYPE-USDC`, `PURR-USDC`. 294 pairs. Trades from 2025-03-22; orderbook, L4, TWAP live from 2026-05-05. No funding, OI, liquidations, or candles. |\n\n## Commands\n\n### `oxa auth test`\n\nVerify your API key is valid by making a lightweight API call.\n\n```bash\noxa auth test [--api-key <key>] [--exchange <exchange>] [--symbol <symbol>] [--format <format>]\n```\n\n| Option | Default | Description |\n|--------|---------|-------------|\n| `--api-key` | `OXA_API_KEY` env | Your API key |\n| `--exchange` | `hyperliquid` | Exchange to check against |\n| `--symbol` | `BTC` | Symbol to use for the check |\n| `--format` | `json` | Output format: `json` or `pretty` |\n\n### `oxa orderbook get`\n\nGet an orderbook snapshot for a symbol.\n\n```bash\noxa orderbook get --exchange <exchange> --symbol <symbol> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Coin symbol |\n| `--depth` | No | Number of price levels per side |\n| `--timestamp` | No | Historical timestamp (Unix ms) |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa orderbook history`\n\nGet historical orderbook snapshots over a time range.\n\n```bash\noxa orderbook history --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Coin symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--depth` | No | Number of price levels per side |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa trades fetch`\n\nFetch trade history for a symbol.\n\n```bash\noxa trades fetch --exchange <exchange> --symbol <symbol> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Coin symbol |\n| `--start` | Conditional | Start time (ISO 8601 or Unix ms) |\n| `--end` | Conditional | End time (ISO 8601 or Unix ms) |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor from previous response |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n**Note:** Hyperliquid trades always require `--start` and `--end`. Lighter and HIP-3 can fetch recent trades without a range.\n\n### `oxa candles`\n\nGet OHLCV candle data.\n\n```bash\noxa candles --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Coin symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--interval` | No | `1m`, `5m`, `15m`, `30m`, `1h` (default), `4h`, `1d`, `1w` |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa funding current`\n\nGet the current funding rate.\n\n```bash\noxa funding current --exchange <exchange> --symbol <symbol> [--format <format>]\n```\n\n### `oxa funding history`\n\nGet funding rate history over a time range.\n\n```bash\noxa funding history --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Coin symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--interval` | No | Aggregation: `5m`, `15m`, `30m`, `1h`, `4h`, `1d` |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa oi current`\n\nGet current open interest.\n\n```bash\noxa oi current --exchange <exchange> --symbol <symbol> [--format <format>]\n```\n\n### `oxa oi history`\n\nGet open interest history over a time range.\n\n```bash\noxa oi history --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Coin symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--interval` | No | Aggregation: `5m`, `15m`, `30m`, `1h`, `4h`, `1d` |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa instruments`\n\nList all available instruments/coins on an exchange.\n\n```bash\noxa instruments --exchange <exchange> [--format <format>]\n```\n\n### `oxa liquidations history`\n\nGet liquidation history (Hyperliquid and HIP-3, data from May 2025 for Hyperliquid, Feb 2026 for HIP-3).\n\n```bash\noxa liquidations history --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | `hyperliquid` or `hip3` |\n| `--symbol` | Yes | Coin symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa liquidations volume`\n\nGet pre-aggregated liquidation volume in time-bucketed intervals. Returns total, long, and short USD volumes per bucket.\n\n```bash\noxa liquidations volume --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | `hyperliquid` or `hip3` |\n| `--symbol` | Yes | Coin symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--interval` | No | Aggregation: `5m`, `15m`, `30m`, `1h` (default), `4h`, `1d` |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa liquidations user`\n\nGet liquidations for a specific user address (Hyperliquid only).\n\n```bash\noxa liquidations user --exchange hyperliquid --user <address> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Must be `hyperliquid` |\n| `--user` | Yes | User wallet address (e.g. 0x1234...) |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--coin` | No | Filter by coin symbol |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa summary`\n\nGet a combined market summary in one call: mark price, oracle price, funding rate, open interest, 24h volume, and liquidation volumes.\n\n```bash\noxa summary --exchange <exchange> --symbol <symbol> [--format <format>]\n```\n\n### `oxa prices`\n\nGet mark/oracle/mid price history over a time range.\n\n```bash\noxa prices --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Coin symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--interval` | No | Aggregation: `5m`, `15m`, `30m`, `1h`, `4h`, `1d` |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa freshness`\n\nCheck data freshness across all data types for a symbol.\n\n```bash\noxa freshness --exchange <exchange> --symbol <symbol> [--format <format>]\n```\n\n### `oxa outcomes list` (HIP-4 only)\n\nList HIP-4 outcome markets (binary outcome metadata). Build+ tier.\n\n```bash\noxa outcomes list [--settled true|false|all] [--limit <n>] [--cursor <cursor>] [--format <format>]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--settled` | No | Filter: `true`, `false`, or `all` (default) |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor from previous response |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa outcomes get` (HIP-4 only)\n\nGet a single HIP-4 outcome market detail. The response includes `aggregated_oi` (latest both-sides OI snapshot). Build+ tier.\n\n```bash\noxa outcomes get <outcome_id> [--format <format>]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `outcome_id` | Yes | Numeric outcome id (e.g. `0`, `1`, `42`) |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa orders history`\n\nGet order history with user attribution. Requires Build+ tier.\n\n```bash\noxa orders history --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Trading symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--user` | No | Filter by user wallet address |\n| `--status` | No | Filter by status: `open`, `filled`, `cancelled`, `expired` |\n| `--order-type` | No | Filter by type: `limit`, `market`, `trigger`, `tpsl` |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa orders flow`\n\nGet order flow aggregation. Requires Build+ tier.\n\n```bash\noxa orders flow --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Trading symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--interval` | No | Aggregation interval: `1m`, `5m`, `15m`, `30m`, `1h` (default), `4h`, `1d` |\n| `--limit` | No | Maximum records to return |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa orders tpsl`\n\nGet TP/SL (take-profit / stop-loss) order history. Requires Pro+ tier.\n\n```bash\noxa orders tpsl --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Trading symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--user` | No | Filter by user wallet address |\n| `--triggered` | No | Filter by triggered status: `true` or `false` |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa l4 get`\n\nGet an L4 order-level orderbook reconstruction at a point in time. Requires Pro+ tier.\n\n```bash\noxa l4 get --exchange <exchange> --symbol <symbol> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Trading symbol |\n| `--timestamp` | No | Historical timestamp (Unix ms or ISO 8601) |\n| `--depth` | No | Number of price levels per side |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa l4 diffs`\n\nGet L4 orderbook diffs (individual order-level changes) over a time range. Requires Pro+ tier.\n\n```bash\noxa l4 diffs --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Trading symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa l4 history`\n\nGet L4 orderbook checkpoints (full snapshots at periodic intervals) over a time range. Requires Pro+ tier.\n\n```bash\noxa l4 history --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Trading symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa l2 get`\n\nGet an L2 full-depth orderbook snapshot derived from L4 data. Requires Build+ tier.\n\n```bash\noxa l2 get --exchange <exchange> --symbol <symbol> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Trading symbol |\n| `--timestamp` | No | Historical timestamp (Unix ms or ISO 8601) |\n| `--depth` | No | Number of price levels per side |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa l2 history`\n\nGet L2 full-depth orderbook history over a time range. Requires Build+ tier.\n\n```bash\noxa l2 history --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Trading symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--depth` | No | Number of price levels per side |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa l2 diffs`\n\nGet L2 tick-level diffs over a time range. Requires Pro+ tier.\n\n```bash\noxa l2 diffs --exchange <exchange> --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--exchange` | Yes | Exchange name |\n| `--symbol` | Yes | Trading symbol |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n### `oxa l3 get`\n\nGet a Lighter L3 order-level orderbook snapshot. Lighter only. Requires Pro+ tier.\n\n```bash\noxa l3 get --symbol <symbol> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--symbol` | Yes | Trading symbol (e.g. BTC, ETH) |\n| `--depth` | No | Number of price levels per side |\n| `--format` | No | `json` (default) or `pretty` |\n\n**Note:** L3 commands are Lighter-only and do not accept an `--exchange` flag.\n\n### `oxa hip4 ...` (HIP-4 outcome markets)\n\nExplicit HIP-4 command surface. Coins are bare numerics (e.g. `0`, `1`, `42`). HIP-4 has no funding, liquidations, or candles by design. Equivalent to `--exchange hip4` on the shared verbs, but reads more naturally for outcome-market workflows.\n\n```bash\n# Discovery\noxa hip4 instruments\noxa hip4 outcomes list --settled false\noxa hip4 outcomes get 0\n\n# Market data\noxa hip4 orderbook get 0 --depth 10\noxa hip4 orderbook history 0 --start 2026-04-01T00:00:00Z --end 2026-04-01T01:00:00Z\noxa hip4 trades 0 --recent --limit 50\noxa hip4 trades 0 --start 2026-04-01T00:00:00Z --end 2026-04-01T01:00:00Z\noxa hip4 oi current 0\noxa hip4 oi history 0 --start 2026-04-01T00:00:00Z --end 2026-04-02T00:00:00Z --interval 1h\noxa hip4 prices 0 --start 2026-04-01T00:00:00Z --end 2026-04-02T00:00:00Z --interval 1h\noxa hip4 summary 0\noxa hip4 freshness 0\n\n# Order-level (Build+ / Pro+ tier)\noxa hip4 orders history 0 --start ... --end ...\noxa hip4 orders flow    0 --start ... --end ... --interval 1h\noxa hip4 orders tpsl    0 --start ... --end ...\noxa hip4 l4 get      0\noxa hip4 l4 diffs    0 --start ... --end ...\noxa hip4 l4 history  0 --start ... --end ...\n```\n\n### `oxa spot ...` (Hyperliquid Spot)\n\nExplicit Spot command surface. Symbols are dashed canonical (`HYPE-USDC`, `PURR-USDC`); the server resolves the dashed form to Hyperliquid's wire formats (`PURR/USDC`, `@107`) internally. Spot has no funding, open interest, liquidations, or candles by design (those are perpetual constructs).\n\nCoverage: trades from 2025-03-22 (HL S3 backfill); orderbook, L4 diffs, L4 orders, and TWAP statuses live from 2026-05-05. 294 pairs covered. Tier gating mirrors HIP-3: Pro+ for L4 and order lifecycle, Build+ for everything else.\n\n```bash\n# Discovery\noxa spot pairs\noxa spot pair HYPE-USDC\n\n# Market data\noxa spot orderbook HYPE-USDC --depth 10\noxa spot trades HYPE-USDC --start 2026-04-01T00:00:00Z --end 2026-04-01T01:00:00Z\noxa spot trades HYPE-USDC --start 2026-04-01T00:00:00Z --end 2026-04-01T01:00:00Z --user 0xabc...\n\n# L4 / order lifecycle (Pro+ tier; live from 2026-05-05)\noxa spot l4 HYPE-USDC\noxa spot orders HYPE-USDC --start 2026-05-05T00:00:00Z --end 2026-05-05T01:00:00Z\n\n# TWAP statuses (Build+ tier; live from 2026-05-05)\noxa spot twap HYPE-USDC --start 2026-05-05T00:00:00Z --end 2026-05-05T01:00:00Z\noxa spot twap-user 0xabc... --start 2026-05-05T00:00:00Z --end 2026-05-05T01:00:00Z\n\n# Per-symbol freshness across orderbook, trades, L4, TWAP\noxa spot freshness HYPE-USDC\n```\n\n| Subcommand | Description | Tier |\n|---|---|---|\n| `oxa spot pairs` | List every active spot pair (294) | Build+ |\n| `oxa spot pair <symbol>` | Get a single spot pair | Build+ |\n| `oxa spot orderbook <symbol>` | Current spot L2 orderbook (live from 2026-05-05) | Build+ |\n| `oxa spot trades <symbol>` | Spot trade history (S3 backfill from 2025-03-22). Requires `--start`/`--end`; supports `--user` filter. | Build+ |\n| `oxa spot l4 <symbol>` | Spot L4 orderbook reconstruction | Pro+ |\n| `oxa spot orders <symbol>` | Spot order lifecycle history with user attribution | Pro+ |\n| `oxa spot twap <symbol>` | TWAP statuses for a single pair | Build+ |\n| `oxa spot twap-user <user>` | TWAP statuses for a single user wallet across all pairs | Build+ |\n| `oxa spot freshness <symbol>` | Per-symbol freshness across orderbook, trades, L4, TWAP | Build+ |\n\nFor realtime spot streams, use `oxa stream subscribe <channel> <symbol>` with one of `spot_orderbook`, `spot_trades`, `spot_l4_diffs`, `spot_l4_orders`, `spot_twap`. Example:\n\n```bash\noxa stream subscribe spot_trades HYPE-USDC --duration-ms 60000\n```\n\n### `oxa stream ...` (realtime WebSocket)\n\nStream live market data over a single WebSocket subscription. Output is NDJSON on stdout (one JSON record per line) by default; `--format pretty` adds a one-line summary per event. Requires Build+ tier (no Free-tier WS access) and Node.js 22+ for the global `WebSocket`.\n\n```bash\n# Realtime liquidations (Hyperliquid; pass `--exchange hip3` for HIP-3 builder perps)\noxa stream liquidations BTC\noxa stream liquidations km:US500 --exchange hip3\n\n# Realtime trades (channel data is the same fill row used by historical /trades, with `is_liquidation: true` on liquidation fills)\noxa stream trades BTC\n\n# Realtime orderbook\noxa stream orderbook BTC --duration-ms 60000\n```\n\nEach `liquidations` / `hip3_liquidations` event is delivered as a fill row with `is_liquidation: true`. To stop early, send SIGINT (Ctrl-C) or pass `--duration-ms`.\n\n### `oxa l3 history`\n\nGet historical Lighter L3 orderbook snapshots over a time range. Lighter only. Requires Pro+ tier.\n\n```bash\noxa l3 history --symbol <symbol> --start <time> --end <time> [options]\n```\n\n| Option | Required | Description |\n|--------|----------|-------------|\n| `--symbol` | Yes | Trading symbol (e.g. BTC, ETH) |\n| `--start` | Yes | Start time (ISO 8601 or Unix ms) |\n| `--end` | Yes | End time (ISO 8601 or Unix ms) |\n| `--depth` | No | Number of price levels per side |\n| `--limit` | No | Maximum records to return |\n| `--cursor` | No | Pagination cursor |\n| `--out` | No | Write JSON output to file |\n| `--format` | No | `json` (default) or `pretty` |\n\n## API Key\n\nThe CLI requires an API key. You can provide it in two ways:\n\n1. **Environment variable** (recommended): `export OXA_API_KEY=\"0xa_your_key\"`\n2. **Flag**: `--api-key 0xa_your_key`\n\nThe `--api-key` flag takes precedence over the environment variable.\n\nGet a free API key at [0xarchive.io](https://0xarchive.io).\n\n## Output Formats\n\n- **`json`** (default): Machine-readable JSON on stdout. Ideal for piping to `jq` or consuming in scripts/agents.\n- **`pretty`**: Human-readable colored output with tables.\n\nErrors always go to stderr as structured JSON `{\"error\":\"...\",\"code\":2,\"type\":\"validation\"}`, never stdout.\n\n## Exit Codes\n\n| Code | Meaning |\n|------|---------|\n| `0` | Success |\n| `2` | Validation error (bad arguments, unknown command) |\n| `3` | Authentication error (missing/invalid key) |\n| `4` | Network or API error |\n| `5` | Internal error |\n\n## Pagination\n\nCommands that return paginated data include a `nextCursor` field in the JSON response. Pass it back with `--cursor` to fetch the next page:\n\n```bash\n# First page\noxa trades fetch --exchange hyperliquid --symbol BTC \\\n  --start 2026-01-01T00:00:00Z --end 2026-01-02T00:00:00Z --limit 100\n\n# Next page (use nextCursor from previous response)\noxa trades fetch --exchange hyperliquid --symbol BTC \\\n  --start 2026-01-01T00:00:00Z --end 2026-01-02T00:00:00Z --limit 100 \\\n  --cursor \"eyJ0IjoxNzA...\"\n```\n\n## For AI Agents\n\nThe CLI is designed for Claude Code, GPT Codex, CI, cron, notebook setup, and other coding-agent pipelines:\n\n```bash\n# Verify API access\noxa auth test 2>/dev/null && echo \"ready\"\n\n# Get multi-signal snapshot\noxa summary --exchange hyperliquid --symbol BTC | jq '{price: .markPrice, funding: .fundingRate, oi: .openInterest}'\n\n# Scan all coins\noxa instruments --exchange hyperliquid | jq '.[].name'\n\n# Fetch candles for backtesting\noxa candles --exchange hyperliquid --symbol ETH \\\n  --start 2026-01-01T00:00:00Z --end 2026-02-01T00:00:00Z \\\n  --interval 4h --out candles.json\n\n# Check funding across exchanges\noxa funding current --exchange hyperliquid --symbol BTC\noxa funding current --exchange lighter --symbol BTC\n\n# Gate on data freshness before acting\noxa freshness --exchange hyperliquid --symbol BTC | jq '.orderbook.lagMs < 5000'\n\n# Get L4 order-level book reconstruction\noxa l4 get --exchange hyperliquid --symbol BTC --format pretty\n\n# Stream L4 diffs for microstructure analysis\noxa l4 diffs --exchange hyperliquid --symbol BTC \\\n  --start 2026-03-01T00:00:00Z --end 2026-03-01T01:00:00Z --out l4_diffs.json\n\n# Query order flow aggregation\noxa orders flow --exchange hyperliquid --symbol ETH \\\n  --start 2026-03-01T00:00:00Z --end 2026-03-02T00:00:00Z --interval 1h\n\n# Get L2 full-depth orderbook\noxa l2 get --exchange hyperliquid --symbol BTC --format pretty\n\n# Get Lighter L3 orderbook snapshot\noxa l3 get --symbol BTC --format pretty\n\n# Stream live liquidations (NDJSON to stdout) for 60s, then exit\noxa stream liquidations BTC --duration-ms 60000\n\n# HIP-4 outcome markets (bare numeric coins)\noxa hip4 outcomes list --settled false\noxa hip4 orderbook get 0 --depth 10\noxa hip4 trades 0 --recent --limit 50\n\n# Hyperliquid Spot (dashed canonical symbols)\noxa spot pairs | jq '.[].symbol' | head\noxa spot pair HYPE-USDC | jq '{symbol, baseTokenName, quoteTokenName}'\noxa spot orderbook HYPE-USDC --depth 5\noxa spot trades HYPE-USDC --start 2026-04-01T00:00:00Z --end 2026-04-01T01:00:00Z --out hype_trades.json\n```\n\n## Data Catalog\n\nFor large-scale data exports (full order books, complete trade history, etc.), use the [Data Catalog](https://www.0xarchive.io/data). It lets you choose markets, datasets, and date ranges, see a live quote, and export zstd-compressed Parquet. The CLI is best for point queries and moderate datasets; the Data Catalog is the file-export path.\n\n## Links\n\n- [API Docs](https://0xarchive.io/docs)\n- [TypeScript SDK](https://npmjs.com/package/@0xarchive/sdk)\n- [Python SDK](https://pypi.org/project/oxarchive/)\n- [MCP Server](https://github.com/0xArchiveIO/0xarchive-mcp)\n- [ClawHub Skill](https://clawhub.ai/0xFantomMenace/0xarchive)\n\n## License\n\nMIT\n","readmeFilename":"README.md"}