Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/stocks/options/chains.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.2 KiB
Vendored

title, description
title description
chains OpenBB SDK Function

chains

Get Option Chain For A Stock. No greek data is returned

Source Code: [link]

openbb.stocks.options.chains(symbol: str, source: str = "Nasdaq", expiration: Optional[str] = None)

Parameters

Name Type Description Default Optional
symbol str Symbol to get chain for None False
source str Source to get data from, by default "Nasdaq" Nasdaq True
expiration Union[str, None] Date to get chain for. By default returns all dates None True

Returns

Type Description
pd.DataFrame Dataframe of full option chain.

Examples

from openbb_terminal.sdk import openbb
aapl_option_chain = openbb.stocks.options.chains("AAPL", source = "Nasdaq")
To get a specific expiration date, use the expiration parameter
aapl_chain_date = openbb.stocks.options.chains("AAPL", expiration="2023-07-21", source="Nasdaq")