This GET endpoint enables you to retrieve an option chain for a specific security. An option chain is a series of options with a fixed number of options with the strike price above and below a center strike price. For instance, if you want an option chain with Range set to 1, you will receive two pairs (Call + Put) of options: one above the center strike price and another below the center strike price.
There are four required parameters that must be provided in the request's header and query:
Authorization (header). This is the authorization token from the very first token request. The value of this header must have the following format: Bearer BQ898r9fefi (Bearer + 1 space + the token).
API version (path). Unless necessary, leave it at "1.0".
symbol (path). This is the ticker symbol of the underlying security for which the option series must be fetched.
There's also one optional parameter worth examining:
filter (query). This is an SQL query used to retrieve only those options that satisfy the conditions of the query. The following table outlines the parameter's syntax.
Syntax
Description
Example
Expiration = {Date}
This query enables you to retrieve options with a specific expiration date.
Expiration = #2020-01-17T00:00:00Z#
Range = {integer}
This query enables you to retrieve the specified number of options below and above the center strike price. For instance, if you want an option chain with Range set to 1, you will receive two pairs (Call + Put) of options: one above the center strike price and another below the center strike price.
Range = 1
ExpirationType
This query enables you to retrieve options of the specified expiration type.
Regular = 0
Quarterly = 1
Weekly = 2
Flex = 3
Undefined = 4
Mini = 5
NonStandard = 6
ExpirationType = 0
Here's the final template for this API request:
GET apiURL/v1.0/options/optionChain/AAPL?filter=Range%20%3D%201%20
Response
In response to this API request, you will receive an option chain filtered according to the specified query: