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
: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): nasdaq.
• Optional: False
start_date
: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date
: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
symbol
: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): nasdaq.
• Optional: False
start_date
: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date
: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
symbol
: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): nasdaq.
• Optional: False
start_date
: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date
: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
limit
: int
The number of data entries to return.
• Default: 100
• Optional: True
symbol
: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): nasdaq.
• Optional: False
start_date
: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date
: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
symbol
: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): nasdaq.
• Optional: False
start_date
: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date
: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
symbol
: Union[str, list[str]]
Symbol to get data for. Multiple items allowed for provider(s): nasdaq.
• Optional: False
start_date
: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date
: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
Data
- standard
- fmp
- intrinio
- nasdaq
- tmx
- yfinance
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.
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.
label
: str
Label of the historical dividends.
adj_dividend
: float
Adjusted dividend of the historical dividends.
record_date
: date
Record date of the historical dividends.
payment_date
: date
Payment date of the historical dividends.
declaration_date
: date
Declaration date of the historical dividends.
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.
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.
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.
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.