Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt

Use this file to discover all available pages before exploring further.

Coding agents need route map, symbol rules, auth handling, tooling setup, and recovery paths before they generate requests against 0xArchive. The safest path is to make the agent name the job, venue family, symbol, time window, execution surface, and quality gate before it writes code. The core distinction: Claude Code, Codex, Cursor, Windsurf, Copilot, Gemini CLI, Devin, OpenCode, and similar products are coding-agent hosts. OpenClaw is a harness/runtime. MCP Server, CLI, SDKs, OpenAPI, docs Markdown, llms.txt, and Skills are reusable context or tool surfaces.

Choose The Surface

User environmentUse this 0xArchive surfaceGood first action
Web LLMDocs pages, .md routes, llms.txt, OpenAPI excerptsAsk it to cite the route family before writing code
Coding agent with repo accessOpenAPI and docs Markdown first; CLI, SDK, MCP, or Skill as neededGive it the exact job, venue, symbol, and time window
Coding agent with terminal accessCLI or SDK, plus OpenAPI for route mapRun one bounded request and inspect JSON before expanding
Automation scriptREST, SDK, CLI JSONStore the interface-specific key variable in the environment
MCP-capable hostMCP ServerConfigure OXARCHIVE_API_KEY in the host secret or environment store
Skill-capable hostSkill / SKILL.md packageLoad reusable route rules and shell-backed request patterns
Generated clientPinned openapi.jsonGenerate routes from the spec, then add data-quality gates
OpenClaw harnessSkill for simple OpenClaw use; ACP for external coding agents; MCP bridge only when neededChoose the OpenClaw path first, then pass 0xArchive context through the matching surface

Why 0xArchive Fits

0xArchive gives agents exact route families and schemas instead of asking them to infer product behavior. A coding agent can read OpenAPI for /v1/hyperliquid/orderbook/BTC, use Venue Coverage to keep HIP-3 and HIP-4 separate, use Authentication for X-API-Key, and use Errors to preserve meta.request_id.

Minimum Job Packet

Give the agent a small packet before it generates a client, script, or workflow:
FieldExampleWhy it matters
Job”Pull historical trades for a backtest”Selects REST, WebSocket, CLI, SDK, MCP Server, Skill, or Data Catalog
Venue familyhyperliquid, hyperliquid/hip3, hyperliquid/hip4, hyperliquid/spot, or lighterPrevents route-family guessing
SymbolBTC, km:US500, %230, HYPE-USDC, or BTC on LighterKeeps symbol parsing explicit
Windowstart, end, limit, and cursor behaviorKeeps historical output reproducible
Execution surfaceREST, CLI, SDK, MCP Server, Skill, or OpenAPI codegenKeeps setup instructions tied to the host
Response contractEndpoint-specific OpenAPI schema, WebSocket message schema, export schema, or data-quality coverage bodyPrevents universal-envelope assumptions
Quality requirementstatus, coverage, incident, latency, or SLA preflightPrevents silent use of stale or interrupted windows

First Bounded Request

For a terminal-capable agent, start with one request and inspect the response before adding loops, storage, or models.
export OXARCHIVE_API_KEY="0xa_your_api_key"

curl "https://api.0xarchive.io/v1/hyperliquid/trades/BTC?start=2026-01-01T00:00:00Z&end=2026-01-01T01:00:00Z&limit=100" \
  -H "X-API-Key: $OXARCHIVE_API_KEY"
The agent should log the route, query parameters, status code, cursor if present, and meta.request_id when the response exposes it. If the next step is a backtest, alert, export, dashboard, or model input, run a Data Quality check for the same venue, symbol, and window before widening.

Use A Different Path When

Do not use 0xArchive tooling surfaces for unsupported venue data, wallet indexing, contract-event search, RPC infrastructure, transaction submission, or account execution. Do not paste real keys into prompts. Put keys in the host environment, secret store, or local process configuration.

Expansion Order

1

Confirm the route family

Use Venue Coverage and OpenAPI before creating route helpers.
2

Run one small request

Inspect JSON shape, endpoint-specific response contract, pagination fields, and request ID before adding storage or loops.
3

Add the quality decision

Store the coverage or incident result with downstream output when the job feeds analysis or production behavior.
4

Choose the durable surface

Keep shell jobs in CLI, tool-calling hosts in MCP Server, reusable host instructions in Skill, application code in SDKs, and route generation in OpenAPI.

Agent Recovery Rules

Ask for the venue family before calling a route. Use Hyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, or Lighter, then pick the generated reference endpoint.
Read OpenAPI instead of inventing fields. Generated clients should keep meta.request_id in logs and errors.
Add a data-quality preflight for backtests, alerts, exports, and model inputs.
Use REST or OpenAPI as the fallback. Add CLI, SDK, MCP, or Skill instructions only when the host and local setup support that surface.

Next Step

Open Choose An Interface for the host/harness/surface matrix, AI And Coding Agents for prompt patterns, and CLI for JSON workflows.
Last modified on May 18, 2026