derivitec.market_data.types.Dividend¶
- class derivitec.market_data.types.Dividend(asset_id=None, reference_date=None, all_in_rate=None, cash_dividend=None, confirmed=None, currency=None, declared_date=None, dividend_type=None, dividend_yield=None, ex_date=None, index_component_asset_id=None, pay_date=None, provider_id=None, record_date=None, type=None, withholding_tax_rate=None)[source]¶
- __init__(asset_id=None, reference_date=None, all_in_rate=None, cash_dividend=None, confirmed=None, currency=None, declared_date=None, dividend_type=None, dividend_yield=None, ex_date=None, index_component_asset_id=None, pay_date=None, provider_id=None, record_date=None, type=None, withholding_tax_rate=None)[source]¶
- Parameters:
asset_id – The asset identifier
reference_date – the reference date
all_in_rate – The all in rate
cash_dividend – The cash dividend
confirmed – The confirmed
currency – The currency
declared_date – The declared date
dividend_type – The dividend type
dividend_yield – The dividend yield
ex_date – The ex date
pay_date – The pay date
provider_id – The provider id
record_date – The record date
type – The type
Methods
IsKeyValuePairListType(key_class_instance, ...)__init__([asset_id, reference_date, ...])json_params()JSON param names.
rebuild(content)Recursive rebuild.
recursive_decompose(item)Helper function to recursively convert some types to a suitable format for json.
to_dict()typename()