derivitec.core.client.DerivitecClient.upload_projected_dividends

DerivitecClient.upload_projected_dividends(dividends, use_best_effort, market_data_environment_name=None)[source]

Upload projected dividends.

Parameters:

  • dividends (list) – The list of dividend

  • use_best_effort (bool) – The use best effort flag

  • market_data_environment_name (str) – The market data environment name (optional with default Organisation Level Environment)

Code

>>> asset_id = bbg("MSFT US")   
>>> reference_date = datetime(2017, 10, 13)
>>> all_in_rate = 0.95
>>> cash_dividend = 3
>>> confirmed = True
>>> declared_date = datetime(2017, 9, 14)
>>>     dividend_type = Dividend.Type.Regular
>>>     dividend_yield = 0.02
>>>     ex_date = datetime(2017, 10, 14)
>>>     pay_date = datetime(2017, 11, 14)
>>>     record_date = datetime(2017, 10, 16)
>>> dividend = Dividend(
...     asset_id = asset_id,
...         reference_date = reference_date,
...         all_in_rate = all_in_rate,
...         cash_dividend = cash_dividend,
...         confirmed = confirmed,
...         declared_date = declared_date,
...         dividend_type = dividend_type,
...         dividend_yield = dividend_yield,
...         ex_date = ex_date,
...         pay_date = pay_date,
...         record_date = record_date)
>>> dividends = [dividend]
>>> use_best_effort = True
>>> market_data_environment_name = "Example Market Data Environment"
>>> client.upload_projected_dividends(dividends, use_best_effort, market_data_environment_name)