OrderMap API documentation

What the API is#

The OrderMap API gives programs the data and the analytics behind the terminal: option order flow, dealer exposure models, volatility, futures order flow, index basis, stock dark pool activity and more. It has three front doors that share one set of endpoints, one key and one rate limit.

Base URLs#

/v1 is the version. Additive changes (new endpoints, new optional parameters, new response fields) can appear in /v1 at any time, so ignore fields you do not know. See Conventions.

Quick start#

1. Open the Developers tab of the OrderMap terminal, create a project and create a key. The full key (it starts with om_) is shown once. Store it somewhere safe. You need an API subscription first.
2. Put the key in an environment variable and call the API with the request below.
3. Read meta.coverage and meta.delayed on every response, follow pagination.next_url until it is null, and respect Retry-After on 429 and 503.

export ORDERMAP_API_KEY='om_...'   # your key

# Who am I, and what may I read?
curl -sS "https://api.ordermap.si/v1/account" \
  -H "Authorization: Bearer $ORDERMAP_API_KEY"

# Up to 100 recent SPXW call sweeps with at least $100,000 of premium
curl -sS --get "https://api.ordermap.si/v1/options/flow" \
  -H "Authorization: Bearer $ORDERMAP_API_KEY" \
  --data-urlencode underlying_symbol=SPXW \
  --data-urlencode contract_type=call \
  --data-urlencode trade_type=sweep \
  --data-urlencode min_premium=100000 \
  --data-urlencode limit=100

const headers = { Authorization: `Bearer ${process.env.ORDERMAP_API_KEY}` };

// Who am I, and what may I read?
const account = await (await fetch("https://api.ordermap.si/v1/account", { headers })).json();
console.log(account.data);

// Up to 100 recent SPXW call sweeps with at least $100,000 of premium
const params = new URLSearchParams({
  underlying_symbol: "SPXW",
  contract_type: "call",
  trade_type: "sweep",
  min_premium: "100000",
  limit: "100",
});
const res = await fetch(`https://api.ordermap.si/v1/options/flow?${params}`, { headers });
const { data, meta, pagination } = await res.json();
console.log(data.length, meta.coverage, pagination.next_cursor_id);

Limits at a glance#

• 250 requests per rolling minute and 30 per rolling second, per account, across all keys. No credits and no overage charges. See Rate limits.
• API Developer ($149.99 a month) covers REST, MCP and exports with a 30-day history window. API Pro ($249.99 a month) adds WebSocket streams, overnight data and a 365-day history window. See Plans and entitlements.
• Every response says whether its data is delayed or partial, in meta.delayed and meta.coverage. See Responses.

Guides#

API reference#

Every endpoint has its own page: parameters, request body, response schema, an example request in curl and Node.js, and an example response. The reference lists all 170 operations by category. The machine-readable contract is the OpenAPI document at /v1/openapi.json.