okama.Portfolio.dividends

property Portfolio.dividends

Calculate portfolio dividends monthly time series.

Portfolio dividends are obtained by summing asset dividends adjusted to the base currency. Dividends size depends on the portfolio value and number of securities.

Returns:

Series

Portfolio dividends monthly time series.

Examples

>>> pf = ok.Portfolio(['SPY.US', 'BND.US'], ccy='USD', last_date='07-2021')
>>> pf.dividends
2007-05    0.849271
2007-06    3.928855
2007-07    1.551262
2007-08    2.023148
2007-09    4.423416
             ...
2021-03    6.155337
2021-04    3.019478
2021-05    2.056836
2021-06    6.519521
2021-07    2.114071
Freq: M, Name: portfolio_2951.PF, Length: 171, dtype: float64