v36

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2024-11-1856109168.6 KB

Retrieve Option Contracts

Returns all option contracts for the given ticker.

get/api/stock/{ticker}/option-contracts

Path parameters

tickerstring required
Example:AAPL

The ticker symbol.

Query parameters

exclude_zero_dteboolean

Exclude chains expiring the same day.

exclude_zero_oi_chainsboolean

Exclude chains where open interest is zero.

exclude_zero_vol_chainsboolean

Exclude chains where volume is zero.

expirystring date
Example:2024-02-02

Filter by expiry date.

limitinteger
Example:10

The number of items to return. Minimum is 1.

maybe_otm_onlyboolean

Include only out-of-the-money chains.

option_type'call' | 'put'

Filter by option type (call/put).

vol_greater_oiboolean

Include only chains where volume > open interest.

Response

Successful response with option contracts data.

Example response

{
  "data": [
    {
      "ask_volume": 119403,
      "avg_price": "1.0465802437910297887119234370",
      "bid_volume": 122789,
      "floor_volume": 142,
      "high_price": "2.95",
      "implied_volatility": "0.675815680048166",
      "last_price": "0.03",
      "low_price": "0.02",
      "mid_volume": 22707,
      "multi_leg_volume": 7486,
      "nbbo_ask": "0.03",
      "nbbo_bid": "0.03",
      "open_interest": 18680,
      "option_symbol": "AAPL240202P00185000",
      "prev_oi": 18680,
      "stock_multi_leg_volume": 52,
      "sweep_volume": 18260,
      "total_premium": "27723806.00",
      "volume": 264899
    }
  ]
}