Venue metadata & endpoint guide

Code snippets

curl "https://api.oanor.com/bitmex-api/v1/meta" \
  -H "x-oanor-key: oanor_test_..."

await fetch("https://api.oanor.com/bitmex-api/v1/meta", {
  headers: { "x-oanor-key": "oanor_test_..." }
});

$ch = curl_init("https://api.oanor.com/bitmex-api/v1/meta");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-oanor-key: oanor_test_..."]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$out = curl_exec($ch);

import requests
requests.get(
    "https://api.oanor.com/bitmex-api/v1/meta",
    headers={"x-oanor-key": "oanor_test_..."}
)

Example response

A real response from this endpoint, captured by the latest health check.

{
    "data": {
        "note": "BitMEX uses XBT for Bitcoin — the flagship perpetual is XBTUSD.",
        "venue": "BitMEX",
        "source": "BitMEX public REST (bitmex.com/api/v1), keyless",
        "examples": {
            "ticker": "/v1/ticker?symbol=XBTUSD",
            "trades": "/v1/trades?symbol=XBTUSD&count=10",
            "candles": "/v1/candles?symbol=XBTUSD&binSize=1h&count=100",
            "orderbook": "/v1/orderbook?symbol=XBTUSD&depth=10",
            "instruments": "/v1/instruments?type=FFWCSX"
        },
        "endpoints": {
            "/v1/ticker": "single-instrument ticker (symbol=XBTUSD)",
            "/v1/trades": "recent public trades (symbol, count)",
            "/v1/candles": "bucketed OHLC candles (symbol, binSize in 1m/5m/1h/1d, count)",
            "/v1/orderbook": "live L2 order book split into bids/asks (symbol, depth)",
            "/v1/instruments": "active instruments with mark/last price, funding, OI & 24h volume (filter type)"
        },
        "instrument": "perpetual swaps, futures & FX derivatives",
        "cache_ttl_ms": 5000
    },
    "meta": {
        "timestamp": "2026-06-15T11:15:41.197Z",
        "request_id": "0d1c7663-2166-447c-bc78-3d3e700bafb7"
    },
    "status": "ok",
    "message": "Meta",
    "success": true
}