mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
* 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>
3.0 KiB
Vendored
3.0 KiB
Vendored
title, description, keywords
| title | description | keywords | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| grhist | Learn about using the functions grhist, syncretism model, and syncretism view in OpenBBTerminal to get historical greeks for options on stocks. These Python functions are clearly explained and the source code is provided for in-depth understanding. The page also delineates parameters and return values. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Get histoical option greeks
Source Code: [link]
openbb.stocks.options.grhist(symbol: str, expiry: str, strike: Union[str, float], chain_id: str = "", put: bool = False)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Stock ticker symbol | None | False |
| expiry | str | Option expiration date | None | False |
| strike | Union[str, float] | Strike price to look for | None | False |
| chain_id | str | OCC option symbol. Overwrites other inputs | True | |
| put | bool | Is this a put option? | False | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Dataframe containing historical greeks |
Plots historical greeks for a given option. [Source: Syncretism]
Source Code: [link]
openbb.stocks.options.grhist_chart(symbol: str, expiry: str, strike: Union[float, str], greek: str = "Delta", chain_id: str = "", put: bool = False, raw: bool = False, limit: Union[int, str] = 20, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Stock ticker | None | False |
| expiry | str | Expiration date | None | False |
| strike | Union[str, float] | Strike price to consider | None | False |
| greek | str | Greek variable to plot | Delta | True |
| chain_id | str | OCC option chain. Overwrites other variables | True | |
| put | bool | Is this a put option? | False | True |
| raw | bool | Print to console | False | True |
| limit | int | Number of rows to show in raw | 20 | True |
| export | str | Format to export data | True | |
| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True |
Returns
This function does not return anything