FinancePy

FinancePy API Reference

Equity Swap

financepy.products.equity.equity_swap

Classes

EquitySwap

EquitySwap(effective_dt: financepy.utils.date.Date, term_dt_or_tenor: financepy.utils.date.Date | str, eq_leg_type: financepy.utils.global_types.SwapTypes, eq_freq_type: financepy.utils.frequency.FrequencyTypes, eq_dc_type: financepy.utils.day_count.DayCountTypes, strike: float, quantity: float = 1.0, eq_payment_lag: int = 0, eq_return_type: financepy.utils.global_types.ReturnTypes = <ReturnTypes.TOTAL_RETURN: 1>, rate_freq_type: financepy.utils.frequency.FrequencyTypes = <FrequencyTypes.MONTHLY: 12>, rate_dc_type: financepy.utils.day_count.DayCountTypes = <DayCountTypes.ACT_360: 8>, rate_spread: float = 0.0, rate_payment_lag: int = 0, cal_type: financepy.utils.calendar.CalendarTypes | list | tuple = <CalendarTypes.WEEKEND: 2>, bd_type: financepy.utils.calendar.BusDayAdjustTypes = <BusDayAdjustTypes.FOLLOWING: 2>, dg_type: financepy.utils.calendar.DateGenRuleTypes = <DateGenRuleTypes.BACKWARD: 2>, end_of_month: bool = False)
Class for managing a standard Equity vs Float leg swap. This is a contract in which an equity payment leg is exchanged for a series of floating rates payments. There is no exchange of principal. The contract is entered into at zero initial cost when spreads are zero. The contract lasts from an effective date to a specified maturity date. The equity payments are not known fully until the end of payment period. The floating rate is not known fully until the end of the preceding payment period. It is set in advance and paid in arrears. The value of the contract is the NPV of the two coupon streams. Discounting is done on a supplied discount curve which is separate from the curve from which the implied index rates are extracted.

Methods

value

value(self, value_dt: financepy.utils.date.Date, discount_curve: financepy.market.curves.discount_curve.DiscountCurve, index_curve: financepy.market.curves.discount_curve.DiscountCurve = None, dividend_curve: financepy.market.curves.discount_curve.DiscountCurve = None, current_price: float = None, first_fixing_rate=None)
Value the Equity swap on a valuation date.
Generated automatically from the FinancePy source code. Do not edit this file manually.