mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 21:12:16 +00:00
* 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 |
|---|---|
| comsplit | OpenBB Platform Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
comsplit
Stock Split Calendar.
comsplit(start_date: Union[date, str] = None, end_date: Union[date, str] = None, provider: Literal[str] = fmp)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
| end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
| provider | Literal['fmp'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. | fmp | True |
Returns
OBBject
results : List[StockSplitCalendar]
Serializable results.
provider : Optional[Literal['fmp']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
metadata: Optional[Metadata]
Metadata info about the command execution.
Data
| Name | Type | Description |
|---|---|---|
| date | date | Date of the stock splits. |
| label | str | Label of the stock splits. |
| symbol | str | Symbol of the company. |
| numerator | float | Numerator of the stock splits. |
| denominator | float | Denominator of the stock splits. |