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

Path Params
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)

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

string
required

Ticker symbol

Query Params
string

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

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.

Responses
200

No response body

400

Invalid request parameters

403

Not authorized

404

Data not found

429

Rate limit exceeded

500

Internal server error

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!