Options · Single contract

Options contract bars

Candles of one contract: open, high, low, close, volume and trade count.

GET/v1/options/contract/barsoptionsContractBars

API Developer Overnight data: API Pro Paginated History-bounded Dataset: options

On this page

Example request
Parameters
Response
Example response
Related

Trade candles of one contract from 1-minute to daily, oldest first, paginated with cursor_id. bar_time is the start of the interval; intervals without a trade are omitted. Daily candles (interval=1d, at most 366 days) come from the end-of-day record and carry bar_time 00:00 ET of the trading date; intraday candles accept a range of at most 31 days, or one trading date, and a session.

Example request

curl -sS --get "https://api.ordermap.si/v1/options/contract/bars" \
  -H "Authorization: Bearer $ORDERMAP_API_KEY" \
  --data-urlencode underlying_symbol=SPXW \
  --data-urlencode contract_type=call \
  --data-urlencode strike=5800 \
  --data-urlencode date_of_expiry=2026-10-16

const params = new URLSearchParams({
  underlying_symbol: "SPXW",
  contract_type: "call",
  strike: "5800",
  date_of_expiry: "2026-10-16",
});
const res = await fetch(`https://api.ordermap.si/v1/options/contract/bars?${params}`, {
  headers: { Authorization: `Bearer ${process.env.ORDERMAP_API_KEY}` },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data, meta } = await res.json();
console.log(data, meta.coverage);
// Paginated: repeat with cursor_id set to pagination.next_cursor_id until it is null.

Set ORDERMAP_API_KEY to your key. Replace the dates with a recent trading date.

Parameters

11 parameters, 4 required.

Parameter	Type and limits	Description
`underlying_symbol`queryrequired	stringat most 8 characterspattern ^[A-Za-z][A-Za-z0-9.]{0,7}$	Option root of the contract, at most six characters: SPXW (weekly and daily, PM-settled) and SPX (monthly, AM-settled) are different roots, as are NDXP and NDX, RUTW and RUT, QQQ, SPY, XSP ...
`contract_type`queryrequired	stringcallput	call or put.
`strike`queryrequired	number> 0max 99999.999	Strike price in dollars with at most three decimals, for example 5800 or 5812.5.
`date_of_expiry`queryrequired	stringdate	Expiration date of the contract, YYYY-MM-DD.
`interval`queryoptional	string1m5m10m15m30m1h1ddefault 1m	Candle length.
`start_time`queryoptional	integerunix-msmin 946684800000max 4102444800000	Start of the range, Unix epoch milliseconds, inclusive. At most 31 days for intraday candles, 366 days for daily ones.
`end_time`queryoptional	integerunix-msmin 946684800000max 4102444800000	End of the range, Unix epoch milliseconds, exclusive. At most 31 days for intraday candles, 366 days for daily ones.
`date`queryoptional	stringdate	One trading date, YYYY-MM-DD, instead of start_time and end_time. With a session of gth the window starts on the evening before.
`session`queryoptional	stringrthgthalldefault rth	Trading session: rth is the regular session (09:30-16:15 ET), gth the overnight session that ends on the morning of the trading date (the previous evening 20:15 ET to 09:25 ET, split at midnight ET), all is both with the curb session (to 17:00 ET). gth and all require the overnight entitlement.
`limit`queryoptional	integerdefault 1000min 1max 5000	Maximum rows to return.
`cursor_id`queryoptional	stringat most 1024 characters	Opaque cursor returned as pagination.next_cursor_id; resumes the same query on the next page.

Response

Status	Meaning	Body
`200`	Successful response.	Schema below
`400`	Invalid, unknown or repeated parameters, or an invalid cursor.	Error object
`401`	Missing or invalid API key.	Error object
`403`	The plan, dataset release or account state does not allow this request.	Error object
`422`	The request is valid but no data exists for it.	Error object
`429`	Rate limit, burst limit or cooldown; wait Retry-After seconds.Retry-After	Error object
`500`	Internal error.	Error object
`503`	Data temporarily unavailable; retry after Retry-After seconds.Retry-After	Error object
`504`	The request timed out.	Error object

Authenticated responses carry the X-RateLimit-* headers (see rate limits); 429 and 503 add Retry-After.

200 response body

dataarray<object>required9 fields inside
- bar_timeintegerunix-msrequiredStart of the interval. Unix epoch milliseconds (UTC).
- closenumberrequiredLast trade price.
- highnumberrequiredHighest trade price.
- lownumberrequiredLowest trade price.
- opennumberrequiredFirst trade price.
- option_symbolstringrequiredOCC option symbol of the contract: root padded to six characters, expiration YYMMDD, C or P and the strike in thousandths over eight digits.
- trade_countintegerrequiredTrades in the interval.
- volumeintegerrequiredContracts traded.
- vwapnumber | nullrequiredVolume-weighted average price; null for daily candles.
metaobjectrequiredMeta object
paginationobjectrequiredPagination object

Example response

{
  "data": [
    {
      "option_symbol": "SPXW  261016C05800000",
      "bar_time": 1792157400000,
      "open": 12.4,
      "high": 13.1,
      "low": 12.2,
      "close": 12.9,
      "volume": 320,
      "trade_count": 41,
      "vwap": 12.71
    }
  ],
  "meta": {
    "as_of": 1760659200123,
    "coverage": {
      "complete": true
    },
    "delay_ms": 0,
    "delayed": false,
    "request_id": "0199f0c2-5a1e-7c3b-9d4e-2b6f8a1c3d5e",
    "source": "opra"
  },
  "pagination": {
    "count": 1,
    "has_more": false,
    "limit": 1000,
    "next_cursor_id": null,
    "next_url": null
  }
}

Values are illustrative. Missing values are null, never 0.

Export this endpointWrite the whole result to a file in the background