v1

latestOpenAPI 3.0.32026-08-0615081.4 KB
v1

Get a current or historical end of day options chain for an underlying ticker symbol. Optional parameters allow for extensive filtering of the chain. Use the optionSymbol returned from this endpoint to get quotes, greeks, or other information using the other endpoints.

get/v1/options/chain/{underlying}/

Path parameters

underlyingstring required

The underlying ticker symbol for the options chain you wish to lookup. Ticker Formats: (TICKER, TICKER.EX, EXCHANGE:TICKER)

Query parameters

format'csv' | 'json'

The format parameter is used to specify the format for your data. We support JSON and CSV formats. The default format is JSON.

datestring date

Use to lookup a historical end of day options chain from a specific trading day. If no date is specified the chain will be the most current chain available during market hours. When the market is closed the chain will be from the last trading day. Accepted date inputs: ISO 8601, unix, spreadsheet.

expirationstring date

Limit the option chain to a specific expiration date. Accepted date inputs: ISO 8601, unix, spreadsheet. If omitted next monthly expiration will be returned.

fromstring date

Limit the option chain to expiration dates after from (inclusive). Should be combined with to to create a range. Accepted date inputs: ISO 8601, unix, spreadsheet. If omitted next monthly expiration will be returned.

tostring date

Limit the option chain to expiration dates before to (not inclusive). Should be combined with from to create a range. Accepted date inputs: ISO 8601, unix, spreadsheet. If omitted next monthly expiration will be returned.

monthinteger

Limit the option chain to options that expire in a specific month (1-12).

yearinteger

Limit the option chain to options that expire in a specific year.

weeklyboolean

Limit the option chain to weekly expirations by setting weekly to true and omitting the monthly and quarterly parameters. If set to false, no weekly expirations will be returned.

monthlyboolean

Limit the option chain to standard monthly expirations by setting monthly to true and omitting the weekly and quarterly parameters. If set to false, no monthly expirations will be returned.

quarterlyboolean

Limit the option chain to quarterly expirations by setting quarterly to true and omitting the weekly and monthly parameters. If set to false, no quarterly expirations will be returned.

dteinteger

Days to expiry. Limit the option chain to a single expiration date closest to the dte provided. Should not be used together with from and to. Take care before combining with weekly, monthly, quarterly, since that will limit the expirations dte can return. If you are using the date parameter, dte is relative to the date provided.

side'call' | 'put'

Limit the option chain to either call or put. If omitted, both sides will be returned.

range'all' | 'itm' | 'otm'

Limit the option chain to strikes that are in the money, out of the money, or include all. If omitted all options will be returned. Valid inputs: itm, otm, all.

strikestring

Limit the option chain to options with the specific strike specified.

minOpenInterestnumber float

Limit the option chain to options with an open interest greater than or equal to the number provided. Can be combined with minVolume and minLiquidity to further filter.

minVolumeinteger

Limit the option chain to options with an volume transacted greater than or equal to the number provided.

maxBidAskSpreadnumber float

Limit the option chain to options with a bid-ask spread less than or equal to the number provided.

maxBidAskSpreadPctnumber float

Limit the option chain to options with a bid-ask spread less than or equal to the percent provided (relative to the underlying). For example, a value of 0.5% would exclude all options trading with a bid-ask spread greater than $1.00 in an underlying that trades at $200.

nonstandardboolean

Include non-standard contracts by setting nonstandard to true. If set to false, no non-standard options will be returned. If omitted, defaults to false.

deltastring

Limit the option chain to options with a delta value close to the specified value.

strikeLimitinteger

Limit the number of strikes returned to the N closest strikes to the at-the-money strike.

minBidnumber float

Limit the option chain to options with a bid price greater than or equal to the number provided.

maxBidnumber float

Limit the option chain to options with a bid price less than or equal to the number provided.

minAsknumber float

Limit the option chain to options with an ask price greater than or equal to the number provided.

maxAsknumber float

Limit the option chain to options with an ask price less than or equal to the number provided.

amboolean

Limit the option chain to AM-settled options by setting am to true. If set to false, no AM-settled options will be returned.

pmboolean

Limit the option chain to PM-settled options by setting pm to true. If set to false, no PM-settled options will be returned.

dateformat'spreadsheet' | 'timestamp' | 'unix'

The dateformat parameter allows you specify the format you wish to receive date and time information in.

limitinteger

The limit parameter allows you to limit the number of results for a particular API call or override an endpoint's default limits to get more data.

offsetinteger

The offset parameter is used together with limit to allow you to implement pagination in your application. Offset will allow you to return values starting at a certain value.

headersboolean

The headers parameter is used to turn off headers when using CSV output.

columnsstring

The columns parameter is used to limit the results and only request the columns you need. The most common use of this feature is to embed a single numeric result from one of the end points in a spreadsheet cell.

humanboolean

Use human-readable attribute names in the JSON or CSV output instead of the standard camelCase attribute names.

Response

object required