SDKs

Call 0xArchive from Python, TypeScript, or Rust with typed requests, pagination, WebSocket helpers, and order-book reconstruction. All three SDKs are open source; these pages match version 1.12.0. Set your key once. Each example below reads it from the environment:

export OXARCHIVE_API_KEY="0xa_your_api_key"

Python
TypeScript
Rust

Python 3.9 or later:

pip install oxarchive==1.12.0

first_call.py

from oxarchive import Client

client = Client()  # reads OXARCHIVE_API_KEY
book = client.hyperliquid.orderbook.get("BTC", depth=1)
print(book.coin, book.mid_price)

python first_call.py

For live streams and replay, install pip install 'oxarchive[websocket]==1.12.0'. Source: 0xArchiveIO/sdk-python.

Node.js 18 or later. The example uses top-level await, so the project is an ES module:

mkdir oxarchive-first-call && cd oxarchive-first-call
npm init -y
npm pkg set type=module
npm install --save-exact @0xarchive/sdk@1.12.0

first-call.ts

import { OxArchive } from "@0xarchive/sdk";

const client = new OxArchive({ apiKey: process.env.OXARCHIVE_API_KEY! });
const book = await client.hyperliquid.orderbook.get("BTC", { depth: 1 });
console.log(book.coin, book.midPrice);

npx tsx first-call.ts

Responses use camelCase field names. Source: 0xArchiveIO/sdk-typescript.

cargo new oxarchive-first-call && cd oxarchive-first-call
cargo add oxarchive@=1.12.0
cargo add tokio --features rt-multi-thread,macros

Replace src/main.rs with:

src/main.rs

use oxarchive::resources::orderbook::GetOrderBookParams;
use oxarchive::OxArchive;

#[tokio::main]
async fn main() -> oxarchive::Result<()> {
    let client = OxArchive::from_env()?; // reads OXARCHIVE_API_KEY
    let params = GetOrderBookParams { depth: Some(1), ..Default::default() };
    let book = client.hyperliquid.orderbook.get("BTC", Some(params)).await?;
    println!("{} {}", book.coin, book.mid_price.unwrap_or_default());
    Ok(())
}

cargo run

For live streams and replay, enable the websocket feature: cargo add oxarchive@=1.12.0 --features websocket. Source: 0xArchiveIO/sdk-rust.

A successful run prints BTC and the current mid price, such as BTC 85726.5. A missing or invalid key fails with a 401 error instead. Installation covers the WebSocket extras and pinned installs.

Venue clients

Each venue has its own client, so your code always names the market it reads:

Hyperliquid perpetuals: client.hyperliquid, with HIP-3 under client.hyperliquid.hip3 and HIP-4 under client.hyperliquid.hip4.
Hyperliquid Spot: client.spot in Python and TypeScript, and client.hyperliquid.spot in Rust.
Lighter: client.lighter. Lighter on Robinhood Chain: client.rh_lighter in Python and Rust, and client.rhLighter in TypeScript.

For another language, call the REST API directly or generate a client from OpenAPI.

Errors

A failed request raises OxArchiveError in Python and TypeScript, and returns Error::Api in Rust. Each carries the HTTP status, a stable error_code to branch on, and the request_id to quote to support. The SDKs send API version 2026-10-01, so a few codes are newer names than raw REST returns by default: a window older than your plan’s history is historical_depth_exceeded rather than history_window_exceeded. Errors lists every code.

Next step

REST usage

Request options, pagination, response handling, and the full namespace map for each SDK.

CLI

MCP

Agent skill

AI agents

SDKs

Venue clients

Errors

Next step

REST usage

​Venue clients

​Errors

​Next step

REST usage

Venue clients

Errors

Next step