openbb-0xarchive extension adds 0xArchive to the OpenBB Platform. Every dataset comes back as an OpenBB result you can turn into a DataFrame, and every command also appears as a widget in OpenBB Workspace.
It covers Hyperliquid perps, HIP-3, HIP-4, Hyperliquid Spot, Lighter, and Lighter on Robinhood Chain. Requests go from your machine to our API with your own key.
Set up
1
Install the extension
openbb-derivatives to also list our perps under obb.derivatives.futures.2
Add your 0xArchive key
Sign up, open API keys in the dashboard and create one. Then set it in Python:To keep it across sessions, add
"oxarchive_api_key" to credentials in ~/.openbb_platform/user_settings.json.3
Load a market
What you can load
Call each one as
obb.oxarchive.<group>.<command>, for example obb.oxarchive.liquidations.levels(symbol="BTC"). Candles, symbol search and perp listings also work through OpenBB’s standard obb.crypto and obb.derivatives.futures commands with provider="oxarchive".
Not every dataset exists on every venue. Pass venue to choose one; the command lists the venues it accepts. Venue coverage has the start date of each dataset.
How results are shaped
- Order books come back as one row per price level, with
sideandlevel.l4andl3return one row per resting order, with the wallet or account that placed it. A full BTC L4 book is about 55,000 rows, sol4_historyreturns one snapshot by default and at most 10; usel4_diffsto follow the book over time. - Symbols use the same form as the REST API:
BTC,xyz:NVDA,HYPE, and#<id>for HIP-4 outcomes.BTC-USDandBTC-PERPmap toBTC. - History comes back oldest first and pages through the API for you.
limitcaps the rows returned, or the snapshots for order book history. For the latest trades, pass a recentstart_date, or usemarket.trades_recenton venues that offer it. - Intervals: funding, open interest and price series default to
1h. Passinterval="raw"for every update. - Plan limits: a request outside your plan stops with the reason and a link to pricing.
OpenBB Workspace
Runopenbb-api on your machine and add it as a backend in OpenBB Workspace. The 0xArchive widgets appear under Crypto, grouped the same way as the commands above.
Next step
Venue coverage
Check how far back each dataset goes before you load a long window.
Source code
Read the extension, open an issue, or run its tests.