Documentation
Everything you need to build on Optiom.
Guides, API reference, schemas, and beta integration notes for the graphs terminal and Optiom Data.
Schemas & data dictionary
Every data format Optiom supports — order book, trades, OHLCV, definitions, statistics — with the full list of fields.
Browse by topic
Getting started
Create an account, request beta access, and make your first Optiom Data request.
QuickstartAuthentication
Beta access, backend keys, rate limits, and how public API keys will work.
Auth guideAPI reference
Current REST endpoints: candles, funding, liquidations, trades, depth, OI, and ETF flows.
Browse endpointsCSV & exports
CSV exports are in private preview; use the API routes first for beta integrations.
Export docsClients & examples
Plain curl, fetch, and Python requests examples until official SDKs are published.
View examplesWebhooks & streaming
WebSocket URL handoff exists for live charts; public stream docs are still preview.
Streaming docsQuickstart
Your first request
Use plain HTTP clients today; official SDKs and self-serve API keys come after the beta contract is stable.
import requests
res = requests.get(
"https://app.optiom.io/api/tradinghub/funding",
params={"symbol": "BTCUSDT", "max_rows": 5000},
timeout=15,
)
res.raise_for_status()
funding = res.json()
print(funding[:3])Can't find what you need?
Check the full API reference or reach the team — we answer integration questions fast.