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>
2.9 KiB
Vendored
2.9 KiB
Vendored
title, description, keywords
| title | description | keywords | |||||||
|---|---|---|---|---|---|---|---|---|---|
| hist_ce | This page describes two main functionalities of the OpenBBFinance documentation: 'hist_ce' function for getting historical prices for a specific stock option and 'hist_ce_chart' function for displaying the same historical stock data in charts. Both functions come with detailed explanations of their parameters and expected returns. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Historic prices for a specific option [chartexchange]
Source Code: [link]
openbb.stocks.options.hist_ce(symbol: str = "GME", date: str = "2021-02-05", call: bool = True, price: Union[str, int, float] = "90")
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Ticker symbol to get historical data from | GME | True |
| date | str | Date as a string YYYYMMDD | 2021-02-05 | True |
| call | bool | Whether to show a call or a put | True | True |
| price | Union[str, Union[int, float]] | Strike price for a specific option | 90 | True |
Returns
| Type | Description |
|---|---|
| pd.Dataframe | Historic information for an option |
Return raw stock data[chartexchange]
Source Code: [link]
openbb.stocks.options.hist_ce_chart(symbol: str = "GME", expiry: str = "2021-02-05", call: bool = True, price: float = 90, limit: int = 10, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Ticker symbol for the given option | GME | True |
| expiry | str | The expiry of expiration, format "YYYY-MM-DD", i.e. 2010-12-31. | 2021-02-05 | True |
| call | bool | Whether the underlying asset should be a call or a put | True | True |
| price | float | The strike of the expiration | 90 | True |
| limit | int | Number of rows to show | 10 | True |
| export | str | Export data as CSV, JSON, XLSX | 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