Sign in

v1

latestOpenAPI 3.0.32026-07-246185298.2 KB
Options

Option Details

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.

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

get/api/v1/stock/{exchange_symbol}/{ticker}/options/details/{parameter_name}

Path parameters

exchange_symbolstring 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_namestring 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' }

tickerstring required

Ticker symbol

Query parameters

as_of_datestring

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

days_backstring

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

ticker_as_of_datestring

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.

Response

No response body