Skip to main content
Install the 0xArchive SDK for TypeScript, Python, or Rust, set your API key, and confirm the setup with your first call. The commands below pin the version these docs describe; the unpinned Python forms are pip install oxarchive and pip install 'oxarchive[websocket]'.
The package includes the REST client, the OxArchiveWs WebSocket client, and the reconstruction helpers.

​
Set your key

Every SDK reads the key you pass to its client, so load it from the environment or your secret store, never from source code.

​
Packages

Source repositories: sdk-typescript · sdk-python · sdk-rust. Each venue family has its own client namespace. TypeScript and Python Spot helpers use client.spot; Rust Spot helpers use client.hyperliquid.spot. HIP-3 and HIP-4 helpers sit under client.hyperliquid.*. In Python, import Client for REST and OxArchiveWs for WebSocket work once the websocket extra is installed. When the installed version has no helper for a route family you need, call that route over REST or generate a client from OpenAPI.

​
Pin the version

Keep the SDK version explicit in your dependency file and read the release notes before upgrading a client that runs production jobs. A market-data client can fail quietly when a response envelope, pagination helper, or decimal parsing changes. Record the package name, the version, any enabled websocket feature or extra, and its registry page (npm, PyPI, or crates.io) with the project. Then make one narrow authenticated call, such as the Hyperliquid BTC order book in SDK REST usage. It confirms the key, base URL, response parsing, and request ID before you add history, replay, or reconstruction.

​
Languages without a package

Call REST or the WebSocket directly, run the CLI from a shell, or generate a typed client from OpenAPI.

​
Next step

Make your first SDK calls with SDK REST usage.
Last modified on October 6, 2026