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>
1.8 KiB
Vendored
1.8 KiB
Vendored
title, description, keywords
| title | description | keywords | ||||
|---|---|---|---|---|---|---|
| hist | The page explains how to get historical option pricing using the OpenBB SDK in Python. It provides a detailed guide for parameters and return types along with examples. You may choose data source from ChartExchange or Tradier. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
Get historical option pricing.
Source Code: [link]
openbb.stocks.options.hist(symbol: str, exp: str, strike: Union[int, float, str], call: bool = True, source: Any = "ChartExchange")
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for | None | False |
| exp | str | Expiration date | None | False |
| strike | Union[int ,Union[float,str]] | Strike price | None | False |
| call | bool | Flag to indicate a call, by default True | True | True |
| source | str | Source to get data from. Can be ChartExchange or Tradier, by default "ChartExchange" | ChartExchange | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | DataFrame of historical option pricing |
Examples
from openbb_terminal.sdk import openbb
aapl_150_call = openbb.stocks.options.hist("AAPL", "2022-11-18", 150, call=True, source="ChartExchange")
Because this generates a dataframe, we can easily plot the close price for a SPY put:
(Note that Tradier requires an API key)
openbb.stocks.options.hist("SPY", "2022-11-18", 400, call=False, source="Tradier").plot(y="close)