---
title: "0xArchive OpenAPI Reference | REST API Contract"
description: "Human-readable overview of the 0xArchive OpenAPI JSON contract for REST market-data routes, schemas, authentication, and data-quality checks."
canonical_url: "https://www.0xarchive.io/openapi/"
markdown_url: "https://www.0xarchive.io/openapi.md"
route: "/openapi"
robots: "index, follow"
generated_from: "prerendered_html"
---

OpenAPI

# 0xArchive OpenAPI reference.

A human-readable overview of the public REST contract for 0xArchive market data, authentication, venue route families, and data-quality checks.

[Open openapi.json](https://www.0xarchive.io/openapi.json)

[View llms guide](https://www.0xarchive.io/llms/)

**1.5.0** Version

**116** Operations

**90** Schemas

**https://api.0xarchive.io** Base URL

Route families

## What the REST contract covers.

### Hyperliquid core

Instruments, order books, trades, candles, funding, open interest, liquidations, freshness, and order-level routes.

### Hyperliquid scoped families

Spot, HIP-3 builder perpetuals, and HIP-4 outcome markets live under the Hyperliquid namespace.

### Lighter.xyz

Separate Lighter routes for instruments, order books, trades, candles, funding, open interest, and freshness.

### Data quality

Status, coverage, incidents, latency, and SLA routes for checking operational context before relying on a window.

API basics

## Fetch the JSON contract for exact schemas.

The raw file is the contract used by automated clients. This page summarizes the public surface and links to the current JSON file.

| Version | 1.5.0 |
| --- | --- |
| Operations | 116 |
| Schemas | 90 |
| Base URL | https://api.0xarchive.io |
| Authentication | X-API-Key header for market-data requests |
| Raw JSON | [https://www.0xarchive.io/openapi.json](https://www.0xarchive.io/openapi.json) |

Excerpt

## Representative route excerpts.

Use the raw JSON file before generating clients, validating parameters, or citing response schemas.

```
GET /health
GET /v1/hyperliquid/orderbook/{symbol}
GET /v1/hyperliquid/hip3/candles/{symbol}
GET /v1/hyperliquid/hip4/outcomes
GET /v1/lighter/orderbook/{symbol}
GET /v1/data-quality/status
```

Related references

## Use these pages with the REST contract.

### [Developer docs](https://docs.0xarchive.io/)

Human guides for authentication, REST routes, WebSocket use, SDKs, and examples.

### [llms.txt guide](https://www.0xarchive.io/llms/)

Reference order, venue taxonomy, and answer rules for AI assistants.

### [Status](https://www.0xarchive.io/status/)

Health, freshness, incident, coverage, latency, and SLA context before operational claims.

Access

## Authentication and access levels still apply.

- Use X-API-Key for authenticated market-data requests.
- Use GET /health for unauthenticated liveness checks.
- Use openapi.json for exact parameters, schemas, and access requirements.

Business identity

0xArchive is operated by Archive Labs Inc., a Delaware corporation.

Mailing address PO Box 194, Troy, NH 03465, US Support [support@0xarchive.io](mailto:support@0xarchive.io)

0xArchive sells market-data API access and historical Parquet exports. It is not an exchange, wallet, broker, trading venue, DeFi protocol, token issuer, custodian, or investment-advice service.

0xArchive never asks for seed phrases or private keys and does not custody customer funds.

Hyperliquid and Lighter.xyz are third-party venue names used to identify data coverage. 0xArchive is not affiliated with, sponsored by, or endorsed by Hyperliquid or Lighter.xyz, and venue references do not imply exchange access, brokerage, custody, or investment advice.