derivitec.core.client.DerivitecClient.get_projected_dividends_for_env

DerivitecClient.get_projected_dividends_for_env(market_date, identifiers=None, market_data_environment_names=None)

Get projected dividends for env. :param market_date: The market date. :type market_date: datetime :param identifiers: The identifiers. :type identifiers: List of InstrumentIdentifier (if not supplied all dividends are queried) :param market_data_environment_name: The market data environment names (if none supplied all org environments are used) :type market_data_environment_name: List of str :rtype:

Code

Get dividend data for SPX.

>>> identifier = [ric(".SPX")]
>>> market_data_environment_name = "Example Market Data Environment"
>>> client.get_dividend_data(datetime(2024, 8, 1), identifiers, market_data_environment_name)