dividends

Return declared dividends, with ex, record, and payable dates.

Examples

from openbb import obb
# Declared dividend history.
obb.tmx.equity.fundamental.dividends(symbol='BNS', provider='tmx')

Parameters

• standard
• tmx

symbol: str
Symbol to get data for.

start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.

end_date: date | None | str
End date of the data, in YYYY-MM-DD format.

symbol: str
Symbol to get data for.

start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.

end_date: date | None | str
End date of the data, in YYYY-MM-DD format.

---

Returns

results: TmxHistoricalDividends

Serializable results.

provider: str | None

Provider name.

warnings: Optional[list[Warning_]]

List of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.

---

Data

• standard
• tmx

symbol: str | None
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 | None
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 | None
The currency the dividend is paid in.

declaration_date: date | None
The date of the announcement.

record_date: date | None
The record date of ownership for rights to the dividend.

payment_date: date | None
The date the dividend is paid.