mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
62 lines
1.6 KiB
Markdown
Vendored
62 lines
1.6 KiB
Markdown
Vendored
---
|
|
title: chains
|
|
description: This page provides comprehensive instructions on how to get option chain
|
|
for a stock using openbb.stocks.options API. It provides examples including how
|
|
to retrieve data from 'Nasdaq' and fetch specific expiration dates.
|
|
keywords:
|
|
- stock options
|
|
- option chain
|
|
- openbb.stocks.options.api
|
|
- Nasdaq
|
|
- expiration dates
|
|
- stock market API
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks.options.chains - Reference | OpenBB SDK Docs" />
|
|
|
|
Get Option Chain For A Stock. No greek data is returned
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/options_sdk_helper.py#L20)]
|
|
|
|
```python
|
|
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
|
|
|
|
```python
|
|
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
|
|
```
|
|
```python
|
|
aapl_chain_date = openbb.stocks.options.chains("AAPL", expiration="2023-07-21", source="Nasdaq")
|
|
```
|
|
|
|
---
|