Calendar Dividend
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
CalendarDividend | CalendarDividendQueryParams | CalendarDividendData |
Import Statement
from openbb_core.provider.standard_models.calendar_dividend import (
CalendarDividendData,
CalendarDividendQueryParams,
)
Parameters
- standard
- fmp
- nasdaq
| 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, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, nasdaq. | None | True |
| 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, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, nasdaq. | None | True |
| 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, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, nasdaq. | None | True |
Data
- standard
- fmp
- nasdaq
| Name | Type | Description |
|---|---|---|
| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. |
| symbol | str | Symbol representing the entity requested in the data. |
| amount | float | The dividend amount per share. |
| 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. |
| Name | Type | Description |
|---|---|---|
| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. |
| symbol | str | Symbol representing the entity requested in the data. |
| amount | float | The dividend amount per share. |
| 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. |
| adjusted_amount | float | The adjusted-dividend amount. |
| label | str | Ex-dividend date formatted for display. |
| Name | Type | Description |
|---|---|---|
| ex_dividend_date | date | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. |
| symbol | str | Symbol representing the entity requested in the data. |
| amount | float | The dividend amount per share. |
| 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. |
| annualized_amount | float | The indicated annualized dividend amount. |