Skip to main content

Historical Dividends


Implementation details

Class names

Model nameParameters classData class
HistoricalDividendsHistoricalDividendsQueryParamsHistoricalDividendsData

Import Statement

from openbb_core.provider.standard_models.historical_dividends import (
HistoricalDividendsData,
HistoricalDividendsQueryParams,
)

Parameters

NameTypeDescriptionDefaultOptional
symbolUnion[str, List[str]]Symbol to get data for. Multiple items allowed for provider(s): nasdaq.False
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', 'intrinio', 'nasdaq', 'tmx', 'yfinance']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.fmpTrue

Data

NameTypeDescription
ex_dividend_datedateThe ex-dividend date - the date on which the stock begins trading without rights to the dividend.
amountfloatThe dividend amount per share.