Historical Dividends
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
HistoricalDividends | HistoricalDividendsQueryParams | HistoricalDividendsData |
Import Statement
from openbb_core.provider.standard_models.historical_dividends import (
HistoricalDividendsData,
HistoricalDividendsQueryParams,
)
Parameters
- standard
- fmp
- intrinio
- nasdaq
- tmx
- yfinance
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp, nasdaq.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp, nasdaq.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
limit: int
Return N most recent payments.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp, nasdaq.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
limit: int
Default: 100
The number of data entries to return.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp, nasdaq.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp, nasdaq.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
symbol: str | list[str]
Symbol to get data for. Multiple items allowed for provider(s): fmp, nasdaq.
start_date: date | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | str
End date of the data, in YYYY-MM-DD format.
Data
- standard
- fmp
- intrinio
- nasdaq
- tmx
- yfinance
symbol: str
Symbol representing the entity requested in the data.
ex_dividend_date: date
The ex-dividend date - the date on which the stock begins trading without rights to the dividend.
amount: float
The dividend amount per share.
symbol: str
Symbol representing the entity requested in the data.
ex_dividend_date: date
The ex-dividend date - the date on which the stock begins trading without rights to the dividend.
amount: float
The dividend amount per share.
declaration_date: date
Declaration date of the historical dividends.
record_date: date
Record date of the historical dividends.
payment_date: date
Payment date of the historical dividends.
adjusted_amount: float
Split-adjusted dividend amount.
dividend_yield: float
Dividend yield represented by the payment.
frequency: str
Frequency of the payment.
symbol: str
Symbol representing the entity requested in the data.
ex_dividend_date: date
The ex-dividend date - the date on which the stock begins trading without rights to the dividend.
amount: float
The dividend amount per share.
factor: float
factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.
currency: str
The currency in which the dividend is paid.
split_ratio: float
The ratio of the stock split, if a stock split occurred.
symbol: str
Symbol representing the entity requested in the data.
ex_dividend_date: date
The ex-dividend date - the date on which the stock begins trading without rights to the dividend.
amount: float
The dividend amount per share.
dividend_type: str
The type of dividend - i.e., cash, stock.
currency: str
The currency in which the dividend is paid.
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.
symbol: str
Symbol representing the entity requested in the data.
ex_dividend_date: date
The ex-dividend date - the date on which the stock begins trading without rights to the dividend.
amount: float
The dividend amount per share.
currency: str
The currency the dividend is paid in.
decalaration_date: date
The date of the announcement.
record_date: date
The record date of ownership for rights to the dividend.
payment_date: date
The date the dividend is paid.
symbol: str
Symbol representing the entity requested in the data.
ex_dividend_date: date
The ex-dividend date - the date on which the stock begins trading without rights to the dividend.
amount: float
The dividend amount per share.