0xArchive Examples

Notebook and small-service projects that turn 0xArchive market data into working analysis.

0xArchive is granular market data infrastructure for Hyperliquid and Lighter. Hyperliquid includes core perps, HIP-3 builder perps, HIP-4 outcome markets, and Hyperliquid Spot; Lighter is the second top-level venue API. Use these examples when you want to verify before wiring an SDK, building an API loop, or exporting Parquet from the Data Catalog.

Start Here

1. Create an account at 0xArchive signup.
2. Copy an API key from the dashboard.
3. Choose the notebook that matches the dataset you want to inspect.
4. Run the notebook once before adapting it into a pipeline.

cp .env.example .env
# Add OXARCHIVE_API_KEY=0xa_your_api_key to .env

Projects

Project	Dataset	Venue scope	Tier	First output
Liquidation Heatmap	Liquidation events and price context	Hyperliquid	Any tier; Free covers the most recent 30 days	Heatmap and scatter views of BTC liquidation clusters
Funding Rate Scanner	Funding rates and spread calculations	Hyperliquid and Lighter	Any tier; Free covers the most recent 30 days	Cross-venue funding chart, spread bands, and carry view
HIP-3 Asset Dashboard	Funding, open interest, trades	Hyperliquid HIP-3	Any tier; Free covers the most recent 30 days	Dashboard for builder-perp price, flow, and derivatives context
Lighter Live Stream	Live order books and trades over WebSocket	Lighter	Any tier; each live message is metered	Top-of-book, spread, depth, and taker-flow views from a short live capture
Webhook Dashboard	Webhook deliveries: liquidations, venue health, watched wallets	Hyperliquid and Lighter	Build or higher (webhook delivery starts on Build)	Live dashboard fed by signed webhook deliveries

Liquidation Heatmap

cd liquidation-heatmap
pip install -r requirements.txt
cp .env.example .env
jupyter notebook liquidation_heatmap.ipynb

Outputs:

• Price-vs-time liquidation heatmap
• Long/short liquidation scatter plot
• Time-of-day and day-of-week views
• Size distribution and P99 cascade detection

Funding Rate Scanner

cd funding-rate-scanner
pip install -r requirements.txt
cp .env.example .env
jupyter notebook funding_rate_scanner.ipynb

Outputs:

• Hyperliquid vs Lighter funding comparison
• Funding spread with two-standard-deviation bands
• Annualized carry view
• Opportunity window and distribution summaries

HIP-3 Asset Dashboard

cd hip3-asset-dashboard
pip install -r requirements.txt
cp .env.example .env
jupyter notebook hip3_asset_dashboard.ipynb

Outputs:

• Hyperliquid HIP-3 funding, open interest, and trade-flow views
• Funding distribution and annualized APR view
• Volume, fill-count, and trade-size summaries
• Price, volume, and open-interest overlays

Lighter Live Stream

cd lighter-live-stream
pip install -r requirements.txt
cp .env.example .env
jupyter notebook lighter_live_stream.ipynb

Streams lighter_orderbook (with interval_ms) and lighter_trades from wss://api.0xarchive.io/ws for a short window (60 seconds by default), using the raw WebSocket protocol.

Outputs:

• Best bid, best ask, and mid from live top-20 books
• Quoted spread in basis points and top-20 size on each side
• Taker buy and sell volume, counting each trade once by tid
• Capture summary with book, trade, and volume totals

Webhook Dashboard

A dependency-free Node receiver plus a live page. It verifies the 0xa-signature header over the raw body (both secrets are accepted during a rotation), acknowledges before doing any work, deduplicates on the event id, and streams events to the browser over server-sent events.

cd webhook-dashboard
WEBHOOK_SECRET=whsec_... node server.js

Outputs:

• Live event tape with per-type counts and deliveries per minute
• Block-to-server latency split at observed_at, and the late flag on catch-up deliveries

Choose Your Next Path

If you want...	Go here
A recurring API loop	SDK docs
Live streams or historical replay	WebSocket docs
A shell or agent workflow	CLI docs
Claude Code, ChatGPT Codex, or other coding-agent context	AI Clients
File-based historical pulls	Data Catalog
Route, schema, and auth details	Quick Start, OpenAPI, llms.txt

Links

• API Docs
• Python SDK
• TypeScript SDK
• Rust SDK
• CLI
• MCP Server
• 0xArchive Skill

Requirements

• Python 3.10+
• Jupyter Notebook
• An 0xArchive API key

No notebook should require secrets in source control. Keep API keys in local .env files only.