Documentation

Understand Optiom's data access boundaries.

Bounded Web Lite projections, internal Desktop data transport, and a separate authenticated and licensed Developer API program.

Search the docs — previews, methodology, access…

View Web Lite contracts Request developer access

Schemas & data dictionary

A field dictionary for candidate licensed datasets. It is not the public Web Lite response contract or an availability promise.

Browse schemas

Browse by topic

Getting started

Make a bounded Web Lite GET request and handle the preview.v1 unavailable state correctly.

Preview quickstart

Authentication

Web Lite previews are anonymous and capped; developer access has separate authentication, quotas, rights and terms.

Access boundaries

Web Lite projections

Versioned GET projections for retail views, with allowlisted parameters and fixed server-side caps.

Browse projections

Datasets & exports

Web Lite has no anonymous CSV export. Dataset and export rights are reviewed through the Developer API program.

View access model

Clients & examples

Small curl, fetch and Python examples for the bounded preview.v1 envelope—not an extraction SDK.

View preview examples

Webhooks & streaming

Desktop live transport is internal. Streaming and automation are not part of the public Web Lite contract.

View product boundary

Quickstart

Your first bounded request

Read the preview.v1 truth envelope first. Until source rights and pipeline timestamps are qualified, HTTP 503 with state unavailable is the expected fail-closed response.

PythonJavaScriptCSV

import requests

res = requests.get(
    "https://www.getoptiom.com/api/tradinghub/funding",
    params={"symbol": "BTCUSDT", "max_rows": 5000},
    timeout=15,
)
res.raise_for_status()

funding = res.json()
print(funding[:3])

Popular guides

Learn by example

Funding

Read a bounded funding comparison in Python

9 min

Liquidations

Understand a capped liquidation-cascade view

6 min

CSV

Choose Web Lite, Desktop or Developer API access

11 min

Whales

Filter a bounded sample of large aggregate trades

7 min

All guides & resources

Can't find what you need?

Review the Web Lite projection contract or contact the team to discuss separately licensed developer access.

Web Lite contracts Contact us