REST first
GET routes with query params for cacheable reads.
Optiom Data API beta
Real market data endpoints, documented as they work today.
This beta reference covers the current Optiom Data routes used by the terminal: OHLCV, funding, liquidations, trades, depth, footprint and ETF flows. SDKs and CSV exports are marked preview until they are actually self-serve.
curl "https://app.optiom.io/api/tradinghub/ohlcv?symbol=BTCUSDT&timeframe=1h&limit=200" \ -H "accept: application/json"
Server-shaped
Next routes reshape backend rows before the browser sees them.
Beta gated
Access is controlled by account and backend secret while self-serve keys are built.
Live preview
WebSocket handoff exists for live charts, with public stream docs still preview.
Endpoint reference
Routes available in the current beta.
/api/tradinghub/healthGETLive{ ok, status }
Backend liveness and transport health.
Params: -
/api/tradinghub/ohlcvGETLive{ candles, volume }
Historical candles for charts, backtests and notebooks.
Params: symbol, timeframe, limit, start, end
/api/tradinghub/candlesGETLive{ candles, volume }
Same OHLCV source, shaped for the terminal chart.
Params: symbol, timeframe, max_rows, end
/api/tradinghub/fundingGETLiveMetricPoint[]
Funding rate history as time/value points.
Params: symbol, start, end, max_rows
/api/tradinghub/funding/matrixGETBeta{ symbols, meta }
Cross-symbol funding history for heatmaps and rankings.
Params: symbols, days, max_rows
/api/tradinghub/funding/venuesGETBeta{ rows, venues, meta }
Latest venue-level funding comparison.
Params: -
/api/tradinghub/liquidationsGETLive{ rows }
Liquidation events and levels.
Params: symbol, start, end, max_rows
/api/tradinghub/tradesGETLive{ rows }
Aggregated trades for tape, CVD and tick mode.
Params: symbol, start, end, max_rows
/api/tradinghub/depthGETBeta{ cols, priceLevels, cells }
Book depth snapshots for liquidity heatmaps.
Params: symbol, minutes, end, max_rows
/api/tradinghub/footprintGETBeta{ priceLevels, candles, tape }
Footprint candles already reshaped server-side.
Params: symbol, timeframe, bars, end
/api/tradinghub/oiGETBeta{ oi }
Open interest history for derivatives views.
Params: symbol, timeframe, bars, end
/api/tradinghub/etf-flowsGETPreview{ asset, latest, days, issuers }
Spot ETF daily flow summaries.
Params: asset
/api/tradinghub/ws-urlWSPreview{ url }
Returns the current live WebSocket URL for terminal charts.
Params: -
Beta contract
What developers should know before integrating.
The current API is production-shaped but still beta-gated. Build experiments against it, but treat API keys, CSV exports and public WebSocket docs as private preview until they are marked live.
Authentication
Beta access is account-gated. Public API keys are not self-serve yet.
Caching
Live requests use a short CDN cache. Historical ranges can be cached longer.
Timeouts
Upstream Optiom Data calls are bounded. Unavailable UI routes may degrade gracefully.
Errors
Current beta routes can return empty payloads with unavailable flags while the terminal stays usable.
Units
Timestamps can be seconds or ISO input. Prices are USD/USDT unless a route states otherwise.
Exports
CSV export is still private preview. Do not build production flows around it yet.
Quickstart
Start with OHLCV and funding routes, then move into liquidations and order flow.
Freshness
Use health and status checks before running heavier data pulls or live chart sessions.
Error handling
Expect 503 for missing backend config and unavailable flags for degraded beta data.
Next step: self-serve keys and OpenAPI.
This page now documents what exists. The next developer milestone is a generated OpenAPI file, Postman collection, and real account-level API key management.