Files
OpenBB/website/content/platform/data_models/StockSplitCalendar.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.4 KiB
Vendored

title, description
title description
Stock Split Calendar OpenBB Platform Data Model

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


Implementation details

Class names

Model name Parameters class Data class
StockSplitCalendar StockSplitCalendarQueryParams StockSplitCalendarData

Import Statement

from openbb_provider.standard_models.stock_splits import (
StockSplitCalendarData,
StockSplitCalendarQueryParams,
)

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

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.