Files
OpenBB/website/content/sdk/reference/stocks/options/grhist.md
jose-donato 2e7eb4c9b6 New documentation website (#3526)
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

2.4 KiB
Vendored

title, description
title description
grhist OpenBB SDK Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

grhist

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