Options · Reference and discovery
Options underlyings
Underlyings that have listed options.
GET
/v1/options/underlyingsoptionsUnderlyingsEvery underlying symbol that has listed options, alphabetically, paginated with cursor_id. search narrows the list to symbols that start with the text (SPX returns SPX, SPXL, SPXW ...). Use a symbol as underlying_symbol on the other options routes; index options trade under their own roots such as SPX and SPXW.
Example request
curl -sS "https://api.ordermap.si/v1/options/underlyings" \
-H "Authorization: Bearer $ORDERMAP_API_KEY"const res = await fetch("https://api.ordermap.si/v1/options/underlyings", {
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
3 parameters, none required.
| Parameter | Type and limits | Description |
|---|---|---|
searchqueryoptional | stringat most 8 characterspattern ^[A-Za-z0-9.]{1,8}$ | Return only symbols starting with this text, case-insensitive. |
limitqueryoptional | integerdefault 1000min 1max 5000 | Maximum rows to return. |
cursor_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>required1 fields insideunderlying_symbolstringrequiredSymbol of the underlying or option root.
metaobjectrequiredMeta objectpaginationobjectrequiredPagination object
Example response
{
"data": [
{
"underlying_symbol": "SPXW"
}
],
"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.