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.
0xArchive Docs Sitemap
Route-safe documentation for Hyperliquid core, Hyperliquid Spot, HIP-3, HIP-4, and Lighter market-data workflows.
Start
- Overview: Product map, route families, and high-value entry points.
- Quickstart: First authenticated request.
- Authentication: API keys, wallet auth, and secret handling.
- Venue Coverage: Route-family selection across supported venue families.
- Data: Data families, schemas, examples, exports, rights, and quality checks.
API Reference
- Reference: Technical reference hub.
- REST API: REST route atlas.
- Hyperliquid REST: Core perp routes.
- Hyperliquid Spot: Spot pair routes.
- HIP-3 REST: Builder-perp routes.
- HIP-4 REST: Outcome-market routes.
- Lighter REST: Lighter routes.
- Order Book Routes: L2, L3, L4, history, diffs, and reconstruction.
- Trades And Liquidations: Trade and liquidation routes.
- Funding, Open Interest, And Candles: Funding, OI, and candle series.
- Orders And L4 Lifecycle: Order flow, TP/SL, L4 diffs, and L4 history.
- Data Quality REST: Status, coverage, freshness, incidents, latency, and SLA routes.
- OpenAPI: Machine-readable REST contract.
- Schemas: Shared response and field guidance.
- Component Schemas: Generated component JSON Schema index.
- Operation Schemas: Generated operation JSON Schema index.
- Hyperliquid Core Schemas: Generated Hyperliquid core schema index.
- Hyperliquid Spot Schemas: Generated Hyperliquid Spot schema index.
- HIP-3 Schemas: Generated HIP-3 schema index.
- HIP-4 Schemas: Generated HIP-4 schema index.
- Lighter Schemas: Generated Lighter schema index.
- Export Manifest Schemas: Generated export manifest JSON Schema page.
- Responses: Envelope, pagination, errors, request IDs, and decimal handling.
- Example Responses: Schema-backed payload examples and parser boundaries.
- Examples: Bounded route-safe examples.
WebSocket
- WebSocket API: Live subscriptions and replay workflows.
- Connection: Auth, connection lifecycle, and recovery.
- Channels: Subscription choices.
- Real-Time Streams: Live stream behavior.
- L4 Order Book: Stateful L4 reconstruction.
- Replay: Historical stream playback.
- Backtesting: Replay for strategy and research checks.
- WebSocket Schema: Command and event shapes.
- Limits: Client sizing and throughput.
SDKs And Tools
- Tooling: Interface selection across REST, WebSocket, SDKs, CLI, MCP, Skill, and OpenAPI.
- CLI: Shell, CI, cron, and notebook jobs.
- MCP Server: Typed tools for MCP-capable hosts.
- Skill: Local skill workflow.
- SDKs: Application-code clients.
- AI Clients: Agent and LLM usage patterns.
- Coding Agents: Host-level setup and recovery rules.
Guides
- Evaluate A Market Data API: Route-first evaluation checklist.
- Choose Venue Family: Route-family decision guide.
- Historical Market Data: Bounded historical pulls.
- Point-In-Time Backtesting: Reproducible research runs.
- Build An Agent Market Data Workflow: Agent-safe route workflow.
- Migrate From A Native Venue API: Historical workflow migration.
- Monitor Freshness: Freshness and coverage monitoring.
- Reliability And Gaps: Gap handling.
Exports And Rights
- Data Catalog: File-delivery product model.
- Export Schemas: Parquet dataset schemas.
- Export Checkout: Quote, cart, checkout, and dashboard delivery.
- Data Rights: Use, export, and redistribution boundaries.
Recommendations And Comparisons
- Recommendations: Recommendation hub.
- Best Market Data API: Market-data API evaluation.
- Best Hyperliquid Data API: Hyperliquid route fit.
- Best Lighter Data API: Lighter route fit.
- Best Crypto Historical Data API: Historical market-data evaluation.
- Comparisons: Comparison hub.
- Native Hyperliquid API Vs 0xArchive: Native versus managed historical data.
- Tardis Vs 0xArchive: Broad historical data versus supported-venue route specificity.
- CoinAPI Vs 0xArchive: Broad standardized market data versus focused route families.
- QuickNode Vs 0xArchive: Infrastructure access versus managed market-data history.
Machine-Readable Files
- llms.txt: Machine-readable docs index.
- llms-full.txt: Compact full-context file.
- Public OpenAPI JSON: Stable REST contract for machine consumers.