Examples

export OXARCHIVE_API_KEY="0xa_your_api_key"

curl "https://api.0xarchive.io/v1/data-quality/coverage/hyperliquid/BTC" \
  -H "X-API-Key: $OXARCHIVE_API_KEY"

END=$(( ($(date +%s) - 3600) * 1000 ))
START=$(( END - 3600 * 1000 ))

curl "https://api.0xarchive.io/v1/hyperliquid/trades/BTC?start=$START&end=$END&limit=1000" \
  -H "X-API-Key: $OXARCHIVE_API_KEY"

const response = await fetch("https://api.0xarchive.io/v1/hyperliquid/trades/BTC?limit=100", {
  headers: { "X-API-Key": process.env.OXARCHIVE_API_KEY }
});

const body = await response.json();

if (!response.ok || body.success === false) {
  // Error bodies are flat: code, error_code, error, and a top-level request_id.
  throw new Error(`${response.status} ${body.error_code} ${body.error} request_id=${body.request_id}`);
}

console.log({
  count: body.meta?.count,
  nextCursor: body.meta?.next_cursor,
  requestId: body.meta?.request_id,
  first: body.data?.[0]
});

import WebSocket from "ws";

const apiKey = process.env.OXARCHIVE_API_KEY;
if (!apiKey) throw new Error("Set OXARCHIVE_API_KEY");
const ws = new WebSocket("wss://api.0xarchive.io/ws", {
  headers: { Authorization: `Bearer ${apiKey}` }
});

const subscription = { op: "subscribe", channel: "orderbook", symbol: "BTC" };

ws.onopen = () => ws.send(JSON.stringify(subscription));
ws.onmessage = (event) => {
  const msg = JSON.parse(event.data);
  if (msg.type === "gap_detected") {
    console.warn("Unsafe stream gap", msg);
  }
};
ws.onerror = (event) => console.error("socket error", event);
ws.onclose = (event) => console.warn("socket closed", event.code, event.reason);