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
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. |
|
|
|