v1

latestOpenAPI 3.1.0raw.githubusercontent.com2025-04-25361217.6 KB

Options - Snapshot

Get Option Chain Snapshot

Retrieves a comprehensive snapshot of all options contracts for a specified underlying asset ticker. This consolidates key metrics like pricing, greeks, IV, quotes, trades, and open interest.

get/options/snapshot/chain/{underlyingAsset}

Path parameters

underlyingAssetstring required

The underlying ticker symbol of the option contract (e.g., AAPL).

Query parameters

strike-pricenumber

Query by strike price of a contract.

strike_price.gtnumber

Strike price greater than.

strike_price.gtenumber

Strike price greater than or equal to.

strike_price.ltnumber

Strike price less than.

strike_price.ltenumber

Strike price less than or equal to.

expiration-datestring date

Query by contract expiration date (YYYY-MM-DD).

expiration_date.gtstring date

Expiration date greater than (YYYY-MM-DD).

expiration_date.gtestring date

Expiration date greater than or equal to (YYYY-MM-DD).

expiration_date.ltstring date

Expiration date less than (YYYY-MM-DD).

expiration_date.ltestring date

Expiration date less than or equal to (YYYY-MM-DD).

contract-type'call' | 'put'

Query by the type of contract.

order'asc' | 'desc'

Order results based on the 'sort' field.

limitinteger

Limit the number of results returned.

sortstring

Sort field used for ordering (e.g., 'strike_price', 'expiration_date').

Response

Successful response with the option chain snapshot data. Keys are in kebab-case.

request-idstring

A request id assigned by the server.

statusstring

The status of this request's response.

next-urlstring nullable

URL to fetch the next page of results, if available.