Files
OpenBB/website/content/platform/data_models/CalendarDividend.md
Henrique Joaquim 4400cd9a8f Merge provider and core into core (#5774)
* small changes - moving provider inside the core

* uptade readme

* lint

* remove old provider readme

* leftovers

* refactor website examples

* ruff

* fix nox

* relock

* fix fails_to_deliver headers

* fix for tests that have renamed endpoints

* fix discovery

* removed test for renamed endpoint

* fix broken syntax - test_search_financial_attributes

* fix cash/income/balance

* fix derivatives tests

* fix etf tests

* fix news tests

* fix regulators

* black

* wrong test param

* sort equity gainers/losers by percent

* platform markdown generation import

* Hotfix/fix int tests core merge (#5779)

* removing tests on old endpoint

* removing visualization on old endpoint

* fixing equity tests

* fixing examples

* fix news tests

* fix index test

* example

* add comments

* example

---------

Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
2023-11-22 13:48:01 +00:00

2.9 KiB
Vendored

title, description
title description
Upcoming and Historical Dividend 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
CalendarDividend CalendarDividendQueryParams CalendarDividendData

Import Statement

from openbb_core.provider.standard_models. import (
CalendarDividendData,
CalendarDividendQueryParams,
)

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', 'nasdaq'] 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 The date of the data. (Ex-Dividend)
symbol str Symbol representing the entity requested in the data.
name str Name of the entity.
record_date date The record date of ownership for eligibility.
payment_date date The payment date of the dividend.
declaration_date date Declaration date of the dividend.
amount float Dividend amount, per-share.
Name Type Description
date date The date of the data. (Ex-Dividend)
symbol str Symbol representing the entity requested in the data.
name str Name of the entity.
record_date date The record date of ownership for eligibility.
payment_date date The payment date of the dividend.
declaration_date date Declaration date of the dividend.
amount float Dividend amount, per-share.
adjusted_amount float The adjusted-dividend amount.
label str Ex-dividend date formatted for display.
Name Type Description
date date The date of the data. (Ex-Dividend)
symbol str Symbol representing the entity requested in the data.
name str Name of the entity.
record_date date The record date of ownership for eligibility.
payment_date date The payment date of the dividend.
declaration_date date Declaration date of the dividend.
amount float Dividend amount, per-share.
annualized_amount float The indicated annualized dividend amount.