jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-31 22:41:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a5d2e833c47160e2373de4e3b054e9e6dd5e00d1
OpenBB/website/content/platform/reference/fa/split.md
Henrique Joaquim 2d8c35df7a Data Models disposition on the website (#5538) 
* pydantic v4

* flat structure

* md files

* Revert "md files"

This reverts commit bd2170e2ad.

* improve command descriptions

* nice title and description

* human readble data model names on left panel

* implementation details section

* content markdown files

* markdown versioned files

* showcase page

* updates

---------

Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-10-12 18:57:22 +02:00

1.5 KiB
Vendored
Raw Blame History

title, description
title description
split OpenBB Platform Function

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

split

Historical Stock Splits. Historical stock splits data.

split(symbol: Union[str, List[str]], provider: Literal[str] = fmp)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. False
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[HistoricalStockSplits]
        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 The date of the data.
label str Label of the historical stock splits.
numerator float Numerator of the historical stock splits.
denominator float Denominator of the historical stock splits.