OpenAPI is the route and schema contract behind the generated REST reference, production client generation, tests, and coding-agent route selection. The Mintlify REST reference is generated from the pinnedDocumentation Index
Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt
Use this file to discover all available pages before exploring further.
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.
Contract Selection
| Surface | Use | Source |
|---|---|---|
| Generated REST reference | Route discovery inside this portal, generated endpoint pages, examples, and reference checks | Pinned openapi.json used by reference generation |
| Public JSON contract | Production codegen, external machine consumers, and durable agent context | https://docs.0xarchive.io/openapi.json |
| Reference-generation snapshot | Local previews and reference checks inside this portal | Pinned openapi.json used by the docs build |
| Integration smoke | Final confirmation before shipping application code | Public JSON contract plus one authenticated route probe |
Use OpenAPI For
| Job | Use |
|---|---|
| REST reference | Generated endpoint pages, parameters, schemas, examples, and auth state |
| Generated client | Codegen for TypeScript, Python, Go, or internal clients |
| Coding agent | Route selection before the agent writes or runs integration code |
| Regression checks | Route-family parity, examples, and docs links |
| Playground review | Confirm the route path and auth header before browser execution |
Source
https://www.0xarchive.io/openapi.json is checked when reachable. If a newly documented route family is visible in the generated reference but absent from the public JSON endpoint, confirm current account and route availability before using it in production code.
Review Packet
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.| Field | Why it matters |
|---|---|
| Method and path | Prevents clients from guessing between similar route families |
| Venue family | Keeps Hyperliquid core, Spot, HIP-3, HIP-4, and Lighter behavior separate |
| Symbol format | Avoids treating pairs, builder-prefixed symbols, and outcome markets as interchangeable |
| Query parameters | Defines pagination, time windows, limits, and optional filters before loops widen |
| Response schema | Lets typed clients parse the route body instead of copying a nearby example |
| Error responses | Connects auth, validation, rate-limit, access, and upstream failures to the right client action |
| Auth state | Confirms whether the route needs X-API-Key or belongs to a wallet-auth flow |
| Pagination fields | Identifies meta.next_cursor, page size, and request-ID logging requirements |
Generated Reference
REST API
Start with the route-family atlas and generated reference entry point.
Hyperliquid Spot
Spot pairs, order books, trades, L4 reconstruction surfaces, TWAP, and freshness routes.
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.