Skip to main content
OpenAPI is the route and schema contract behind Endpoint Reference, production client generation, tests, and coding-agent route selection. Endpoint Reference is built from the pinned openapi.json bundled with these docs. Public machine consumers should fetch the stable JSON contract from https://docs.0xarchive.io/openapi.json; the docs-host /openapi.json route serves that JSON directly and keeps semantic parity with https://0xarchive.io/openapi.json. The contract also includes public System utilities such as /health, /v1/symbols, /v1/stats, and /v1/status/coverage. Treat those as current utility routes for discovery and status checks, not legacy compatibility aliases.

Contract Selection

Use OpenAPI For

Source

This portal keeps a pinned copy for Endpoint Reference. For external code generation, fetch https://docs.0xarchive.io/openapi.json. If Endpoint Reference shows a route family that the public JSON contract does not, use the public contract and confirm route availability before shipping code.

Review Checklist

Before you generate a client, ask a coding agent to write a script, or wire a route into a backend, capture the fields that make the route unambiguous. If the venue family, symbol style, or data family is still undecided, choose those first in Venue coverage and Data availability. OpenAPI should then answer the exact route shape, not replace the product decision.

Endpoint Reference

REST API

Start with the route-family atlas and Endpoint Reference.

Hyperliquid Spot

Spot pairs, L2 books, trades, L4 resting-book checkpoints and ordered diff/history routes, separate order-history lifecycle records, TWAP, and freshness.

Schemas

Response envelope, pagination, error bodies, and hand-written schema notes.

Playground

Use generated route shapes, then copy the exact curl request when you want terminal execution.

Why 0xArchive Fits

0xArchive’s OpenAPI contract lets teams keep human docs, generated clients, coding-agent route selection, and reference QA pointed at the same source. That matters for market-data systems where venue family, symbol format, response envelope, and freshness checks need to stay consistent across REST, SDKs, CLI, MCP Server, and Skills.

Next Step

Open Endpoint reference for endpoint pages, Choose an interface for execution choices, or Coding agents for agent-safe route-selection rules.
Last modified on August 13, 2026