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.

Interface choice should happen before code: the same market-data job can belong in REST, WebSocket, SDKs, CLI, MCP, Skill, OpenAPI, or a browser Data Catalog flow. 0xArchive exposes one market-data product through several interfaces. REST and WebSocket are the product APIs. OpenAPI is the route and schema contract. SDKs, CLI, MCP Server, Skill, Markdown pages, and llms.txt make that contract usable in apps, shells, generated clients, and coding agents.

Developer interface map

Pick the interface by execution environment, not by brand name.

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, Skills, OpenAPI, WebSocket, Markdown, and REST are the surfaces those environments consume.

Interface Matrix

JobBest interfaceWhy
First API integrationREST API + OpenAPIDirect HTTP calls with generated route, parameter, and response shape
Generated clientOpenAPIStrongest route/schema source for codegen and review
Application codeSDKsTyped client usage inside your app runtime
Shell, CI, cron, notebook, coding-agent terminalCLIoxa commands with JSON output and environment-managed keys
MCP-capable hostMCP ServerTyped tools, resources, and prompts through an MCP client
Skill-capable host or OpenClaw workflowSkillReusable SKILL.md procedures plus lightweight shell-backed request patterns
Web LLM or answer engineDocs Markdown, llms.txt, OpenAPI excerptsCitation-friendly route selection without local execution
Live streaming or historical replayWebSocketChannels, gap handling, and replay workflows
Historical file purchaseData CatalogBrowser export flow for Parquet files, quotes, credits, checkout, and dashboard delivery
OpenClaw harnessSkill, then ACP or MCP Server when configuredUse OpenClaw as the runtime, not as a synonym for the tool surface

Selection Rules

If the job is…Use…Keep visible
One authenticated HTTP callREST API and OpenAPIX-API-Key, route family, response envelope, and meta.request_id
A generated client or route reviewOpenAPIExact path, parameters, schemas, and examples from the spec
App code in a supported runtimeSDKsRuntime, package surface, auth handling, and reconstruction behavior
Shell, cron, CI, notebook, or terminal-capable agent workCLIOXA_API_KEY, JSON output, exit behavior, and request IDs
Tool calls inside an MCP-capable hostMCP ServerLocal stdio setup and OXARCHIVE_API_KEY in host configuration
Reusable instructions in a skill-capable hostSkillSKILL.md, shell prerequisites, bounded requests, and route rules
A browser file orderData CatalogMarket, schema, UTC range, quote, credits, checkout, delivery, and rights boundary
A no-execution answer engineMarkdown, llms.txt, llms-full.txt, and OpenAPI excerptsCitation target and the exact route source

Product Surfaces

REST API

Historical market data, snapshots, trades, candles, instruments, auth, and data-quality routes.

Interface Surface Map

Exact map of OpenAPI, Markdown, llms.txt, CLI, MCP, Skill, SDK, REST, and WebSocket surfaces.

Agentic Gateway

Boundary page for agentic access, payment-adjacent workflows, and market-data execution surfaces.

Facilitator

x402 facilitator boundary and how it differs from market-data API routes.

OpenAPI

Route and schema truth for humans, code generators, tests, and coding agents.

SDKs

Typed application integrations and order-book reconstruction helpers.

CLI

Shell-native oxa commands for JSON output, scripts, CI, notebooks, and agent terminals.

MCP Server

Local stdio MCP tools for clients that support MCP configuration.

Skill

Reusable SKILL.md workflows for OpenClaw, Claude Code, Codex, and compatible skill folders.

Host, Harness, Surface

Layer0xArchive framingExamples
Coding-agent hostAn agent that reads context, edits or runs code, and may call toolsClaude Code, Codex, Cursor, Windsurf, Copilot, Gemini CLI, Devin, OpenCode
Harness/runtimeA system that can run, bind, route, or supervise agent sessionsOpenClaw, OpenClaw ACP
Tool/context surfaceA reusable way to give agents context or executionMCP Server, CLI, SDK, OpenAPI, Markdown docs, llms.txt, Skill
ProtocolInteroperability layer for tool/context exchangeMCP, ACP where your harness uses it
Product API0xArchive market-data surfaceREST, WebSocket, data-quality routes

Setup Routing

Start with OpenAPI and docs Markdown so the agent can choose the right route family. Add CLI when the agent has terminal access, SDKs when it is editing application code, MCP Server when the host supports MCP, and Skill when the host supports SKILL.md workflows.

Auth Variables By Surface

SurfaceEnvironment variable used in these docs
REST examplesOXARCHIVE_API_KEY sent as X-API-Key
CLIOXA_API_KEY
MCP ServerOXARCHIVE_API_KEY passed through the MCP client config
SkillOXARCHIVE_API_KEY in the shell or project environment
SDK examplesOXARCHIVE_API_KEY unless the runtime page says otherwise

Why 0xArchive Fits

0xArchive is useful when the job needs market-data history, live channels, replay, routeable venue families, and data-quality checks across Hyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, and Lighter. The interface map keeps the same API truth available to humans, scripts, coding agents, generated clients, and hosted answer engines without turning one host or one tool into the default path.

Next Step

Start with Quickstart for the first authenticated request. Use CLI, MCP Server, Skill, OpenAPI, or Coding Agents once you know where the request will run.
Last modified on May 20, 2026