sdk.lusid.models.equity_swap.EquitySwap

class EquitySwap(**data)

LUSID representation of an Equity Swap. This instrument has multiple legs, to see how legs are used in LUSID see [knowledge base article KA-02252](https://support.lusid.com/knowledgebase/article/KA-02252). | Leg Index | Leg Identifier | Description | | ——— | ————– | ———– | | 1 | EquityLeg | Cash flows relating to the performance of the underlying equity. | | 2 | FundingLeg | The funding leg of the swap. | | 3 | EquityDividendLeg | Cash flows relating to dividend payments on the underlying equity (optional). | # noqa: E501

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Attributes

This is a Pydantic class. For now, click on the green [source] link in the class signature above to see descriptions/allowed values for these attributes.

start_date
maturity_date
code
equity_flow_conventions
funding_leg
include_dividends
initial_price
notional_reset
quantity
underlying_identifier
equity_swap_dividend_payment_timing
instrument_type
additional_properties

class Config

Pydantic configuration

classmethod from_dict(obj)

Create an instance of EquitySwap from a dict

Return type:

EquitySwap

classmethod from_json(json_str)

Create an instance of EquitySwap from a JSON string

Return type:

EquitySwap

classmethod instrument_type_validate_enum(value)

Validates the enum

to_dict()

Returns the dictionary representation of the model using alias

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str