Skip to main content

Calendar Dividend


Implementation details​

Class names​

Model nameParameters classData class
CalendarDividendCalendarDividendQueryParamsCalendarDividendData

Import Statement​

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

Parameters​

NameTypeDescriptionDefaultOptional
start_dateUnion[date, str]Start date of the data, in YYYY-MM-DD format.NoneTrue
end_dateUnion[date, str]End date of the data, in YYYY-MM-DD format.NoneTrue
providerLiteral['fmp', 'nasdaq']The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, nasdaq.NoneTrue

Data​

NameTypeDescription
ex_dividend_datedateThe ex-dividend date - the date on which the stock begins trading without rights to the dividend.
symbolstrSymbol representing the entity requested in the data.
amountfloatThe dividend amount per share.
namestrName of the entity.
record_datedateThe record date of ownership for eligibility.
payment_datedateThe payment date of the dividend.
declaration_datedateDeclaration date of the dividend.