mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-14 05:14:19 +00:00
f72bc8ccec
* Adding versioning to docs --------- Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: tehcoderer <me@tehcoderer.com>
1.6 KiB
Vendored
1.6 KiB
Vendored
title, description
| title | description |
|---|---|
| splits | OpenBB SDK Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
splits
Get splits and reverse splits events. [Source: Yahoo Finance]
Source Code: [link]
openbb.stocks.fa.splits(symbol: str)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Ticker to get forward and reverse splits | None | False |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Dataframe of forward and reverse splits |
Display splits and reverse splits events. [Source: Yahoo Finance]
Source Code: [link]
openbb.stocks.fa.splits_chart(symbol: str, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Stock ticker symbol | None | False |
| 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