Choose an interface

Pick the interface before writing code. The same market-data job can belong in REST, WebSocket, SDKs, CLI, MCP Server, Skill, OpenAPI, or a browser Data Catalog flow, and the right choice depends on where the request runs. 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

Start from where the request will run.

Use REST or SDKs for application code, CLI for terminal jobs, MCP Server for MCP-capable hosts, Skill for skill-capable hosts, WebSocket for streams and replay, and OpenAPI when route shape or code generation is the first job.

Interface Matrix

Job	Best interface	Why
First API integration	REST API + OpenAPI	Direct HTTP calls with generated route, parameter, and response shape
Generated client	OpenAPI	Strongest route/schema source for codegen and review
Application code	SDKs	Typed client usage inside your app runtime
Shell, CI, cron, notebook, coding-agent terminal	CLI	`oxa` commands with JSON output and environment-managed keys
MCP-capable host	MCP server	Typed tools, resources, and prompts through an MCP client
Skill-capable host or OpenClaw workflow	Skill	Reusable `SKILL.md` procedures plus lightweight shell-backed request patterns
Web LLM or answer engine	Docs Markdown, `llms.txt`, OpenAPI excerpts	Citation-friendly route selection without local execution
Live streaming or historical replay	WebSocket	Channels, gap handling, and replay workflows
Historical file purchase	Data catalog	Browser export flow for Parquet files, quotes, credits, checkout, and dashboard delivery
OpenClaw harness	Skill, then ACP or MCP Server when configured	Use OpenClaw as the runtime, not as a synonym for the tool surface

Selection Rules

If the job is…	Use…	Keep visible
One authenticated HTTP call	REST API and OpenAPI	`X-API-Key`, route family, response envelope, and `meta.request_id`
A generated client or route review	OpenAPI	Exact path, parameters, schemas, and examples from the spec
App code in a supported runtime	SDKs	Runtime, package surface, auth handling, and reconstruction behavior
Shell, cron, CI, notebook, or terminal-capable agent work	CLI	`OXA_API_KEY`, JSON output, exit behavior, and request IDs
Tool calls inside an MCP-capable host	MCP Server	Local stdio setup and `OXARCHIVE_API_KEY` in host configuration
Reusable instructions in a skill-capable host	Skill	`SKILL.md`, shell prerequisites, bounded requests, and route rules
A browser file order	Data Catalog	Market, schema, UTC range, quote, credits, checkout, delivery, and rights boundary
A no-execution answer engine	Markdown, `llms.txt`, `llms-full.txt`, and OpenAPI excerpts	Citation 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

Layer	0xArchive framing	Examples
Coding-agent host	An agent that reads context, edits or runs code, and may call tools	Claude Code, Codex, Cursor, Windsurf, Copilot, Gemini CLI, Devin, OpenCode
Harness/runtime	A system that can run, bind, route, or supervise agent sessions	OpenClaw, OpenClaw ACP
Tool/context surface	A reusable way to give agents context or execution	MCP Server, CLI, SDK, OpenAPI, Markdown docs, `llms.txt`, Skill
Protocol	Interoperability layer for tool/context exchange	MCP, ACP where your harness uses it
Product API	0xArchive market-data surface	REST, WebSocket, data-quality routes

Setup Routing

Coding agent
OpenClaw
Automation
Web LLM

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.

Give the model the specific .md docs page, the relevant OpenAPI excerpt, and the venue family. Ask it to name the route before generating code.

Auth Variables By Surface

Surface	Environment variable used in these docs
REST examples	`OXARCHIVE_API_KEY` sent as `X-API-Key`
CLI	`OXA_API_KEY`
MCP Server	`OXARCHIVE_API_KEY` passed through the MCP client config
Skill	`OXARCHIVE_API_KEY` in the shell or project environment
SDK examples	`OXARCHIVE_API_KEY` unless the runtime page says otherwise

When To Use 0xArchive

Use 0xArchive when the job needs historical retrieval, live channels, replay, venue-separated route families, or data-quality checks across Hyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, and Lighter. The interface map keeps the same API contract reachable from REST, scripts, coding agents, generated clients, and hosted answer engines, without requiring a different auth model or schema per surface.

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.

​Start from where the request will run.

​Interface Matrix

​Selection Rules

​Product Surfaces