Get current HIP-4 open interest
0xArchive API reference for Get current HIP-4 open interest. Includes authentication, parameters, response shape, examples, and route-safe implementation notes.
X-API-Key with this request. See REST authentication.Machine schema
Machine schema
Authorizations
API key for authentication. Get yours at https://0xarchive.io/dashboard
Headers
Selects the 2026-10 response contract. Send 2026-10-01; any dated version on or after it selects the same shapes. Without the header every response keeps its existing shape. With it:
- The data quality routes,
/v1/status/coverageand/v1/symbolsanswer the standard{success, data, meta}envelope. - Record times that are integer milliseconds by default become RFC 3339 UTC strings with millisecond precision, and the integer moves to a
*_msfield: L4 resting-ordertimestamp(timestamp_ms), CVD buckets, HIP-3 oracle reads, Lighter and Lighter on Robinhood Chain liquidations and liquidation volume. Levels and trigger-levelssnapshot_tsbecome RFC 3339 withsnapshot_ts_ms. - Error bodies carry the contract
error_codenames:invalid_parameterinstead ofinvalid_query_paramsandinvalid_path_params,historical_depth_exceededinstead ofhistory_window_exceeded, andhistorical_range_exceededinstead ofrequest_range_exceeded; a malformed cursor that fails to parse answers 400invalid_cursorinstead ofinvalid_query_params. With0xArchive-Version: 2026-10-01, malformed cursors on trades, liquidations, L2 and L4 diffs, order history, TP/SL and order-flow routes answer 400invalid_cursor. Without the header, the first six route families treat a malformed cursor as no cursor and return the first page; order flow answers 400invalid_query_params. Malformed trade time inputs answer 400invalid_time_rangewith the header and 400invalid_query_paramswithout it.
The response echoes the selected version in its own 0xArchive-Version header.
2026-10-01 "2026-10-01"
Path Parameters
Response
Current open interest
API response wrapping a single HIP-4 per-side open-interest record
HIP-4 per-side open-interest record. Mirrors the HIP-3 OI shape and adds outcome_id and side. oracle_price is omitted for HIP-4 (outcomes have no oracle feed). Note: mark_price is an implied probability in [0,1], not a USD price; same field name as perps because Hyperliquid upstream uses markPx for both.