Option Details

get

https://api.ortex.com/api/v1/stock/{exchange_symbol}/{ticker}/options/details/{parameter_name}

API to retrieve option metrics for a given ticker.
This endpoint requires selecting a specific parameter_name, which determines the metric returned.

Available Parameter Names:

oi: Open Interest
volume: Trading Volume
last_price: Last traded price
last_size: Size of the last trade
ask_price: Current ask price
ask_size: Ask size (number of contracts at ask)
bid_price: Current bid price
bid_size: Bid size (number of contracts at bid)
implied_vol: Implied volatility
delta: Option delta
gamma: Option gamma
theta: Option theta
vega: Option vega
rho: Option rho
put_call_oi_ratio: Put/Call Ratio (Open Interest)
put_call_volume_ratio: Put/Call Ratio (Volume)

Parameters:

parameter_name: string, required — must be one of the above values.

Strike Window:

By default the response is limited to the 20 strikes closest to the current underlying price in each direction (a window of up to 40 strikes, shared across all expiries). The window follows the underlying price, so requests made at different times can include different strikes at the window edges.

num_strikes: int, optional — number of strikes returned each side of the at-the-money strike (default: 20, maximum: 500).
all_data: bool, optional — set to true to return the complete option chain with no strike window applied.

Requests widening the window beyond the default are charged proportionally to the number of strikes returned.

Try it out! You can test the API with the trial key TEST. Simply include it in your request headers; either here, or add the header "Ortex-Api-Key": "TEST" to your http request.

Trial key restrictions: A list of randomly selected rows will be returned

Get full access! Get a key at app.ortex.com/apis

Path Params

exchange_symbol

string

required

Exchange symbol (e.g. "nyse", "nasdaq"), MIC code (e.g. "xnys", "xnas") or two character ISO country code (e.g "us", "ca" for ALL country exchanges)

parameter_name

string

required

One of: { 'oi', 'volume', 'last_price', 'last_size', 'ask_price', 'ask_size', 'bid_price',
'bid_size', 'implied_vol', 'delta', 'gamma', 'theta', 'vega', 'rho',
'put_call_oi_ratio', 'put_call_volume_ratio' }

ticker

string

required

Ticker symbol

Query Params

all_data

boolean

Set to true to return the complete option chain with no strike window applied. The credit charge scales with the number of strikes returned.

as_of_date

string

Format yyyy-mm-dd. Returns data up to as_of_date value (default: today).

days_back

string

Returns data from up to days_back days in the past (default: 0). If as_of_date is set, this parameter will be ignored.

num_strikes

integer

Number of strikes returned in each direction from the at-the-money strike (default: 20, maximum: 500 — i.e. by default a window of up to 40 strikes closest to the current underlying price, shared across all expiries). Values above 20 widen the window and scale the credit charge proportionally to the number of strikes returned.

ticker_as_of_date

string

US instruments only. Picks which instrument a ticker refers to, as of the given date (format yyyy-mm-dd).

What it does: changes instrument resolution only. It does not filter or move the returned data — that stays controlled by the endpoint's own data parameters (such as from_date / to_date, or as_of_date on the options endpoints). Think of it as answering "who owned this ticker on this date?", not "what data do I want back?".

Why you need it: tickers get reused, renamed and delisted over time (e.g. FB → META; SPLK was delisted when Cisco acquired Splunk). By default the endpoint matches the ticker on the exchange in the URL path to the currently-active instrument — so a ticker that no longer trades returns 404, and a recycled ticker resolves to today's owner, not the historical one.

When set: the URL path exchange is ignored and all US exchanges are searched for whichever instrument held the ticker on that date. This lets you pull history for a company that has since changed ticker, delisted, or moved exchange.

Rules:

Omitted → current behaviour, exactly unchanged.
Present (any value, even blank or a future date) → as-of resolution is applied; a blank value defaults to today.
A non-US exchange / MIC / country code combined with this parameter returns 400.

Note: on the options endpoints this is distinct from as_of_date, which filters the option data snapshot — ticker_as_of_date only selects the instrument.

Responses

200

No response body

400

Invalid request parameters

403

Not authorized

404

Data not found

429

Rate limit exceeded

500

Internal server error