NDXCS#
- class rateslib.instruments.NDXCS(effective=NoInput.blank, termination=NoInput.blank, frequency=NoInput.blank, *, stub=NoInput.blank, front_stub=NoInput.blank, back_stub=NoInput.blank, roll=NoInput.blank, eom=NoInput.blank, modifier=NoInput.blank, calendar=NoInput.blank, payment_lag=NoInput.blank, payment_lag_exchange=NoInput.blank, ex_div=NoInput.blank, convention=NoInput.blank, leg2_effective=NoInput.inherit, leg2_termination=NoInput.inherit, leg2_frequency=NoInput.inherit, leg2_stub=NoInput.inherit, leg2_front_stub=NoInput.inherit, leg2_back_stub=NoInput.inherit, leg2_roll=NoInput.inherit, leg2_eom=NoInput.inherit, leg2_modifier=NoInput.inherit, leg2_calendar=NoInput.inherit, leg2_payment_lag=NoInput.inherit, leg2_payment_lag_exchange=NoInput.inherit, leg2_ex_div=NoInput.inherit, leg2_convention=NoInput.inherit, currency=NoInput.blank, notional=NoInput.blank, amortization=NoInput.blank, leg2_notional=NoInput.blank, leg2_amortization=NoInput.blank, pair=NoInput.blank, leg2_pair=NoInput.blank, fx_fixings=NoInput.blank, leg2_fx_fixings=NoInput.blank, fixed=NoInput.blank, fixed_rate=NoInput.blank, float_spread=NoInput.blank, spread_compound_method=NoInput.blank, rate_fixings=NoInput.blank, fixing_method=NoInput.blank, method_param=NoInput.blank, fixing_frequency=NoInput.blank, fixing_series=NoInput.blank, leg2_fixed=NoInput.blank, leg2_mtm=NoInput.blank, leg2_fixed_rate=NoInput.blank, leg2_float_spread=NoInput.blank, leg2_spread_compound_method=NoInput.blank, leg2_rate_fixings=NoInput.blank, leg2_fixing_method=NoInput.blank, leg2_method_param=NoInput.blank, leg2_fixing_frequency=NoInput.blank, leg2_fixing_series=NoInput.blank, curves=NoInput.blank, spec=NoInput.blank, metric=NoInput.blank)#
Bases:
_BaseInstrumentA non-deliverable cross-currency swap (XCS) composing either
FixedLegand/orFloatLegin different currencies.Examples
An INR NDXCS vs SOFR (IRUSON5 Curncy)
In [1]: fixings.add("WMR_10AM_TY0_USDINR", Series(index=[dt(2025, 1, 8), dt(2025, 7, 4)], data=[92.0, 92.5])) In [2]: ndxcs = NDXCS( ...: effective=dt(2025, 1, 8), ...: termination="1y", ...: frequency="S", ...: currency="usd", ...: pair="usdinr", ...: notional=5e6, # <- INR Leg ...: fixed=True, ...: fx_fixings="WMR_10AM_TY0", ...: leg2_fx_fixings=91.55, # <- USD Notional at execution ...: payment_lag=0, ...: ) ...: In [3]: ndxcs.cashflows() Out[3]: Type Ccy Payment Notional DF Cashflow NPV FX Rate Base Ccy NPV Ccy Collateral FX Fixing FX Fix Date Reference Ccy Period Convention DCF Acc Start Acc End Rate Spread leg1 0 Cashflow USD 2025-01-08 -5000000.0 None NaN None 1.0 USD None None NaN 2025-01-06 INR NaN NaN NaN NaT NaT NaN NaN 1 FixedPeriod USD 2025-07-08 5000000.0 None NaN None 1.0 USD None None 92.50 2025-07-04 INR Regular Act360 0.502778 2025-01-08 2025-07-08 NaN NaN 2 FixedPeriod USD 2026-01-08 5000000.0 None NaN None 1.0 USD None None NaN 2026-01-06 INR Regular Act360 0.511111 2025-07-08 2026-01-08 NaN NaN 3 Cashflow USD 2026-01-08 5000000.0 None NaN None 1.0 USD None None NaN 2026-01-06 INR NaN NaN NaN NaT NaT NaN NaN leg2 0 Cashflow USD 2025-01-08 5000000.0 None -54614.9645 None 1.0 USD None None 91.55 2025-01-06 INR NaN NaN NaN NaT NaT NaN NaN 1 FloatPeriod USD 2025-07-08 -5000000.0 None NaN None 1.0 USD None None 91.55 2025-01-06 INR Regular Act360 0.502778 2025-01-08 2025-07-08 NaN 0.0 2 FloatPeriod USD 2026-01-08 -5000000.0 None NaN None 1.0 USD None None 91.55 2025-01-06 INR Regular Act360 0.511111 2025-07-08 2026-01-08 NaN 0.0 3 Cashflow USD 2026-01-08 -5000000.0 None 54614.9645 None 1.0 USD None None 91.55 2025-01-06 INR NaN NaN NaN NaT NaT NaN NaN
Pricing
The methods of a NDXCS require an
FXForwardsobject forfx.They also require a disc curve for discounting both legs in the settlement currency and (if not FixedLegs) a rate curve and a leg2 rate curve for forecasting the floating rates on either Leg. The following input formats are allowed:
curves = [rate_curve, disc_curve, leg2_rate_curve, disc_curve] # four curves curves = { # dict form is explicit "rate_curve": rate_curve, "disc_curve": disc_curve, "leg2_rate_curve": leg2_rate_curve, }
The available pricing
metricare in {‘leg1’, ‘leg2’} which will return a float spread or a fixed rate on the specified leg, for the appropriate Leg type.- Parameters:
. –
Note
The following define generalised scheduling parameters.
effective (datetime, required) – The unadjusted effective date. If given as adjusted, unadjusted alternatives may be inferred.
termination (datetime, str, required) – The unadjusted termination date. If given as adjusted, unadjusted alternatives may be inferred. If given as string tenor will be calculated from
effective.frequency (Frequency, str, required) – The frequency of the schedule. If given as string will derive a
Frequencyaligning with: monthly (“M”), quarterly (“Q”), semi-annually (“S”), annually(“A”) or zero-coupon (“Z”), or a set number of calendar or business days (“_D”, “_B”), weeks (“_W”), months (“_M”) or years (“_Y”). Where required, theRollDayis derived as perrolland business day calendar as percalendar.stub (StubInference, str in {“ShortFront”, “LongFront”, “ShortBack”, “LongBack”}, optional) – The stub type used if stub inference is required. If given as string will derive a
StubInference.front_stub (datetime, optional) – The unadjusted date for the start stub period. If given as adjusted, unadjusted alternatives may be inferred.
back_stub (datetime, optional) – The unadjusted date for the back stub period. If given as adjusted, unadjusted alternatives may be inferred. See notes for combining
stub,front_stubandback_stuband any automatic stub inference.roll (RollDay, int in [1, 31], str in {“eom”, “imm”, “som”}, optional) – The roll day of the schedule. If not given or not available in
frequencywill be inferred for monthly frequency variants.eom (bool, optional) – Use an end of month preference rather than regular rolls for
rollinference. Set by default. Not required ifrollis defined.modifier (Adjuster, str in {“NONE”, “F”, “MF”, “P”, “MP”}, optional) – The
Adjusterused for adjusting unadjusted schedule dates into adjusted dates. If given as string must define simple date rolling rules.calendar (calendar, str, optional) – The business day calendar object to use. If string will call
get_calendar().payment_lag (Adjuster, int, optional) – The
Adjusterto use to map adjusted schedule dates into a payment date. If given as integer will define the number of business days to lag payments by.payment_lag_exchange (Adjuster, int, optional) – The
Adjusterto use to map adjusted schedule dates into additional payment date. If given as integer will define the number of business days to lag payments by.ex_div (Adjuster, int, optional) – The
Adjusterto use to map adjusted schedule dates into additional dates, which may be used, for example by fixings schedules. If given as integer will define the number of business days to lag dates by.convention (str, optional (set by ‘defaults’)) – The day count convention applied to calculations of period accrual dates. See
dcf().leg2_effective (datetime, optional (inherited from leg1))
leg2_termination (datetime, str, optional (inherited from leg1))
leg2_frequency (Frequency, str, optional (inherited from leg1))
leg2_stub (StubInference, str, optional (inherited from leg1))
leg2_front_stub (datetime, optional (inherited from leg1))
leg2_back_stub (datetime, optional (inherited from leg1))
leg2_roll (RollDay, int, str, optional (inherited from leg1))
leg2_eom (bool, optional (inherited from leg1))
leg2_modifier (Adjuster, str, optional (inherited from leg1))
leg2_calendar (calendar, str, optional (inherited from leg1))
leg2_payment_lag (Adjuster, int, optional (inherited from leg1))
leg2_payment_lag_exchange (Adjuster, int, optional (inherited from leg1))
leg2_ex_div (Adjuster, int, optional (inherited from leg1))
leg2_convention (str, optional (inherited from leg1)) –
Note
The following define generalised settlement parameters.
currency (str, optional (set by ‘defaults’)) – The local settlement currency of leg1 (3-digit code).
notional (float, Dual, Dual2, Variable, optional (set from ‘leg2_notional’ or ‘defaults’ )) – The initial leg1 notional, defined in units of the currency of the leg. Only one of
notionalandleg2_notionalcan be given. The alternate leg notional is derived via non-deliverabilityFXFixing.amortization (float, Dual, Dual2, Variable, str, Amortization, optional (set as zero)) – Set a non-constant notional per Period. If a scalar value, adjusts the
notionalof each successive period by that same value. Should have sign equal to that of notional if the notional is to reduce towards zero.leg2_currency (str, required) – The currency of the leg2.
leg2_notional (float, Dual, Dual2, Variable, optional (negatively inherited from leg1))
leg2_amortization (float, Dual, Dual2, Variable, str, Amortization, optional (negatively inherited from leg1)) –
Note
The following are the non-deliverability parameters
pair (str, required (if ‘leg2_pair’ not given)) – The currency pair for
FXFixingthat determines Period settlement on Leg1. The reference currency is implied frompair. Must includecurrency. Not required if this leg is not non-deliverable.leg2_pair (str, optional) – The currency pair for
FXFixingthat determines Period settlement on Leg2. Not required if not a 3-currency NDXCS.fx_fixings (float, Dual, Dual2, Variable, Series, str, 2-tuple or list, optional) – The value of the
FXFixingfor each Period according to non-deliverability. Not required if this leg is not non-deliverable.leg2_fx_fixings (float, Dual, Dual2, Variable, Series, str, 2-tuple or list, optional) –
The value of the
FXFixingfor each Period on Leg2 according to non-deliverability. Not required if this leg is not non-deliverable.Note
The following are rate parameters.
fixed (bool, optional (set as False)) – Whether leg1 is a
FixedLegor aFloatLeg.fixed_rate (float or None) – The fixed rate applied to the
FixedLeg. If None will be set to mid-market when curves are provided.fixing_method (FloatFixingMethod, str, optional (set by ‘defaults’)) – The
FloatFixingMethoddescribing the determination of the floating rate for each period.method_param (int, optional (set by ‘defaults’)) – A specific parameter that is used by the specific
fixing_method.fixing_frequency (Frequency, str, optional (set by ‘frequency’ or ‘1B’)) – The
Frequencyas a component of theFloatRateIndex. If not given is assumed to match the frequency of the schedule for an IBOR typefixing_methodor ‘1B’ if RFR type.fixing_series (FloatRateSeries, str, optional (implied by other parameters)) – The
FloatRateSeriesas a component of theFloatRateIndex. If not given inherits attributes given such as thecalendar,convention,method_parametc.float_spread (float, Dual, Dual2, Variable, optional (set as 0.0)) – The amount (in bps) added to the rate in each period rate determination.
spread_compound_method (SpreadCompoundMethod, str, optional (set by ‘defaults’)) – The
SpreadCompoundMethodused in the calculation of the period rate when combining afloat_spread. Used only with RFR typefixing_method.rate_fixings (float, Dual, Dual2, Variable, Series, str, optional) – See Fixings. The value of the rate fixing. If a scalar, is used directly. If a string identifier, links to the central
fixingsobject and data loader.leg2_fixed (bool, optional (set as False))
leg2_fixed_rate (float or None)
leg2_fixing_method (FloatFixingMethod, str, optional (set by ‘defaults’))
leg2_method_param (int, optional (set by ‘defaults’))
leg2_fixing_frequency (Frequency, str, optional (set by ‘frequency’ or ‘1B’))
leg2_fixing_series (FloatRateSeries, str, optional (implied by other parameters))
leg2_float_spread (float, Dual, Dual2, Variable, optional (set as 0.0))
leg2_spread_compound_method (SpreadCompoundMethod, str, optional (set by ‘defaults’))
leg2_rate_fixings (float, Dual, Dual2, Variable, Series, str, optional) –
Note
The following are the cross-currency non-deliverable parameters. For further details and examples see Notes.
fx_fixings – The value of the
FXFixingfor each Period according to non-deliverability. This can only be provided ifleg2_notionalis given. The currency pair is expressed in direction ‘currency:leg2_currency’.mtm (bool, optional (set to False)) – Define the XCS is mark-to-market on leg1. Only one leg can be mark-to-market.
leg2_fx_fixings – This can only be provided if
notionalis given. The currency pair is expressed in direction ‘currency:leg2_currency’.leg2_mtm (bool, optional (set to False)) –
Note
The following are meta parameters.
curves (_BaseCurve, str, dict, _Curves, Sequence, optional) – Pricing objects passed directly to the Instrument’s methods’
curvesargument. See Pricing.spec (str, optional) – A collective group of parameters. See default argument specifications.
metric (str, optional (set as ‘leg1’)) – Determines which calculation metric to return by default when using the
rate()method.
Notes
A non-deliverable XCS replicates a non-mtm cross-currency swap whose cashflows are paid out only in one settlement currency. This type of swap allows two configurations;
A two currency NDXCS where one leg is based on a reference currency and difference settlement currency, whilst the other leg is based purely on cashflows generated in the settlement currency.
A three currency NDXCS where one leg is based on reference currency 1 with a settlement currency and the other leg is based on reference currency 2 but also settling in settlement currency.
The required parameters of a two currency NDXCS are as follows;
A
currencywhich defines the settlement currency on both legs.A
pairwhich defines the currency pair and implicitly determines the reference currency.A
notionalorleg2_notional. The placement of the notional defines which Leg is the one that is based on the reference currency. Any notional quantity must be given in units of reference currency.fx_fixingsandleg2_fx_fixings. These are FX fixings that are used by both legs; one leg will have a fixed rate of exchange for all periods (a single entry usually determined when the transaction is agreed), the other leg with base its ND FX Fixings on some future data series.
This example swaps a 500mm INR FloatLeg non-deliverable into USD into a USD FloatLeg with an initially agreed FX rate of USDINR 92.0
In [4]: ndxcs = NDXCS( ...: effective=dt(2026, 1, 1), ...: termination="18M", ...: frequency="S", ...: currency="usd", # <- USD settlement currency ...: pair="usdinr", # <- INR reference currency implied ...: notional=500e6, # <- Leg1 is based on the reference currency ...: fx_fixings="WMR_10AM_TY0", ...: leg2_fx_fixings=92.0, # <- The USD Leg notional is implied as 5.43mm ...: ) ...: In [5]: ndxcs.cashflows() Out[5]: Type Ccy Payment Notional DF Cashflow NPV FX Rate Base Ccy NPV Ccy Collateral FX Fixing FX Fix Date Reference Ccy Period Convention DCF Acc Start Acc End Rate Spread leg1 0 Cashflow USD 2026-01-01 -500000000.0 None NaN None 1.0 USD None None NaN 2025-12-30 INR NaN NaN NaN NaT NaT NaN NaN 1 FloatPeriod USD 2026-07-03 500000000.0 None NaN None 1.0 USD None None NaN 2026-07-01 INR Regular Act360 0.502778 2026-01-01 2026-07-01 NaN 0.0 2 FloatPeriod USD 2027-01-03 500000000.0 None NaN None 1.0 USD None None NaN 2026-12-31 INR Regular Act360 0.511111 2026-07-01 2027-01-01 NaN 0.0 3 FloatPeriod USD 2027-07-03 500000000.0 None NaN None 1.0 USD None None NaN 2027-07-01 INR Regular Act360 0.502778 2027-01-01 2027-07-01 NaN 0.0 4 Cashflow USD 2027-07-01 500000000.0 None NaN None 1.0 USD None None NaN 2027-06-29 INR NaN NaN NaN NaT NaT NaN NaN leg2 0 Cashflow USD 2026-01-01 500000000.0 None -5.434783e+06 None 1.0 USD None None 92.0 2025-12-30 INR NaN NaN NaN NaT NaT NaN NaN 1 FloatPeriod USD 2026-07-03 -500000000.0 None NaN None 1.0 USD None None 92.0 2025-12-30 INR Regular Act360 0.502778 2026-01-01 2026-07-01 NaN 0.0 2 FloatPeriod USD 2027-01-03 -500000000.0 None NaN None 1.0 USD None None 92.0 2025-12-30 INR Regular Act360 0.511111 2026-07-01 2027-01-01 NaN 0.0 3 FloatPeriod USD 2027-07-03 -500000000.0 None NaN None 1.0 USD None None 92.0 2025-12-30 INR Regular Act360 0.502778 2027-01-01 2027-07-01 NaN 0.0 4 Cashflow USD 2027-07-01 -500000000.0 None 5.434783e+06 None 1.0 USD None None 92.0 2025-12-30 INR NaN NaN NaN NaT NaT NaN NaN
The Leg based on the reference currency is a non-deliverable Leg with a
mtmparameter set to True, whilst the other Leg is non-deliverable withmtmset to False and is based on one single FX rate.The required parameters of a three currency NDXCS are as follows;
A
currencywhich defines the settlement currency on both legs.A
pairwhich defines the currency pair and implicitly determines the reference currency 1.A
leg2_pairwhich defines the currency pair of Leg2 and implicitly determines the reference currency 2.A
notionalandleg2_notional. These must be pre-determined at an appropriate rate of exchange, usually this is agreed at transaction execution. These must be expressed in reference currency 1 units and reference currency 2 units respectively.fx_fixingsandleg2_fx_fixingswhich determine the future rates of exchange on both non-deliverable legs.
This example swaps a 500mm INR FloatLeg non-deliverable into USD into a CHF FloatLeg non-deliverable into USD with an initial FX rate of CHFINR 125.0.
In [6]: fixings.add("WMR_10AM_TY0_USDCHF", Series(index=[dt(2025, 1, 6)], data=[0.9])) In [7]: ndxcs = NDXCS( ...: effective=dt(2026, 1, 1), ...: termination="18M", ...: frequency="S", ...: currency="usd", # <- USD settlement currency ...: pair="usdinr", # <- INR reference currency 1 implied ...: leg2_pair="usdchf", # <- CHF reference currency 2 implied ...: notional=500e6, # <- Leg1 is based on the reference currency 1 ...: leg2_notional=500e6/125.0, # <- Leg2 entered directly in ref currency 2 units ...: fx_fixings="WMR_10AM_TY0", # <- Data series tag for FXFixings on Leg1 ...: leg2_fx_fixings="WMR_10AM_TY0", # <- Data series tag for FXFixings on Leg2 ...: ) ...: In [8]: ndxcs.cashflows() Out[8]: Type Ccy Payment Notional DF Cashflow NPV FX Rate Base Ccy NPV Ccy Collateral FX Fixing FX Fix Date Reference Ccy Period Convention DCF Acc Start Acc End Rate Spread leg1 0 Cashflow USD 2026-01-01 -500000000.0 None None None 1.0 USD None None None 2025-12-30 INR NaN NaN NaN NaT NaT NaN NaN 1 FloatPeriod USD 2026-07-03 500000000.0 None None None 1.0 USD None None None 2026-07-01 INR Regular Act360 0.502778 2026-01-01 2026-07-01 NaN 0.0 2 FloatPeriod USD 2027-01-03 500000000.0 None None None 1.0 USD None None None 2026-12-31 INR Regular Act360 0.511111 2026-07-01 2027-01-01 NaN 0.0 3 FloatPeriod USD 2027-07-03 500000000.0 None None None 1.0 USD None None None 2027-07-01 INR Regular Act360 0.502778 2027-01-01 2027-07-01 NaN 0.0 4 Cashflow USD 2027-07-01 500000000.0 None None None 1.0 USD None None None 2027-06-29 INR NaN NaN NaN NaT NaT NaN NaN leg2 0 Cashflow USD 2026-01-01 -4000000.0 None None None 1.0 USD None None None 2025-12-30 CHF NaN NaN NaN NaT NaT NaN NaN 1 FloatPeriod USD 2026-07-03 4000000.0 None None None 1.0 USD None None None 2026-07-01 CHF Regular Act360 0.502778 2026-01-01 2026-07-01 NaN 0.0 2 FloatPeriod USD 2027-01-03 4000000.0 None None None 1.0 USD None None None 2026-12-30 CHF Regular Act360 0.511111 2026-07-01 2027-01-01 NaN 0.0 3 FloatPeriod USD 2027-07-03 4000000.0 None None None 1.0 USD None None None 2027-07-01 CHF Regular Act360 0.502778 2027-01-01 2027-07-01 NaN 0.0 4 Cashflow USD 2027-07-01 4000000.0 None None None 1.0 USD None None None 2027-06-29 CHF NaN NaN NaN NaT NaT NaN NaN
Both Legs are non-deliverable with their
mtmparameters set to True.Attributes Summary
The fixed rate parameter of the composited
FixedLeg.The float spread parameter of the composited
FloatLeg.The
_KWArgscontainer for the Instrument.The float spread parameter of the composited
FloatLeg.The float spread parameter of the composited
FloatLeg.A list of the Legs of the Instrument.
A scaling quantity associated with the
Solverrisk calculations.The default
_SettlementParamsof the Instrument.Methods Summary
analytic_delta(*[, curves, solver, fx, vol, ...])Calculate the analytic rate delta of a Leg of the Instrument.
cashflows(*[, curves, solver, fx, vol, ...])Return aggregated cashflow data for the Instrument.
cashflows_table(*[, curves, solver, fx, ...])Aggregate the values derived from a
cashflows(), grouped by date, settlement currency and collateral.delta(*[, curves, solver, fx, vol, base, ...])Calculate delta risk of an Instrument against the calibrating instruments in a
Solver.exo_delta(*[, curves, solver, fx, vol, ...])Calculate delta risk of an Instrument against some exogenous user created Variables, via a
Solver.gamma(*[, curves, solver, fx, vol, base, ...])Calculate cross-gamma risk of an Instrument against the calibrating instruments of a
Solver.local_analytic_rate_fixings(*[, curves, ...])Calculate the sensitivity to rate fixings of the Instrument, expressed in local settlement currency per basis point.
local_fixings(identifiers[, scalars, ...])Calculate the sensitivity to fixings of the Instrument, expressed in local settlement currency.
npv(*[, curves, solver, fx, vol, base, ...])Calculate the NPV of the Instrument converted to any other base accounting currency.
rate(*[, curves, solver, fx, vol, base, ...])Calculate some pricing rate metric for the Instrument.
reset_fixings([state])Resets any fixings values of the Instrument derived using the given data state.
spread(*[, curves, solver, fx, vol, base, ...])Calculate some pricing spread metric for the Instrument.
Attributes Documentation
- legs#
A list of the Legs of the Instrument.
- settlement_params#
The default
_SettlementParamsof the Instrument.This is used to define a
basecurrency when one is not specified.
Methods Documentation
- analytic_delta(*, curves=NoInput.blank, solver=NoInput.blank, fx=NoInput.blank, vol=NoInput.blank, base=NoInput.blank, local=False, settlement=NoInput.blank, forward=NoInput.blank, leg=1)#
Calculate the analytic rate delta of a Leg of the Instrument.
Examples
In [9]: curve = Curve({dt(2000, 1, 1): 1.0, dt(2010, 1, 1): 0.75}) In [10]: irs = IRS(dt(2000, 1, 1), "3Y", spec="usd_irs", fixed_rate=1.0, curves=[curve]) In [11]: irs.analytic_delta() Out[11]: 287.14750127899316 In [12]: irs.analytic_delta(local=True) Out[12]: {'usd': 287.14750127899316}
- Parameters:
curves (_Curves, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
solver (Solver, optional) – A
Solverobject containing Curve, Smile, Surface, or Cube mappings for pricing.fx (FXForwards, optional) – The
FXForwardsobject used for forecasting FX rates, if necessary.vol (_Vol, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
base (str, optional (set to settlement currency)) – The currency to convert the local settlement NPV to.
local (bool, optional (set as False)) – An override flag to return a dict of NPV values indexed by string currency.
settlement (datetime, optional) – The assumed settlement date of the PV determination. Used only to evaluate ex-dividend status.
forward (datetime, optional) – The future date to project the PV to using the
disc_curve.leg (int, optional (set as 1)) – The Leg over which to calculate the analytic rate delta.
- Return type:
float, Dual, Dual2, Variable or dict of such indexed by string currency.
- cashflows(*, curves=NoInput.blank, solver=NoInput.blank, fx=NoInput.blank, vol=NoInput.blank, base=NoInput.blank, settlement=NoInput.blank, forward=NoInput.blank)#
Return aggregated cashflow data for the Instrument.
Warning
This method is a convenience method to provide a visual representation of all associated calculation data. Calling this method to extract certain values should be avoided. It is more efficient to source relevant parameters or calculations from object attributes or other methods directly.
Examples
In [1]: irs = IRS(dt(2000, 1, 1), "3Y", spec="usd_irs", fixed_rate=1.0) In [2]: irs.cashflows() Out[2]: Type Ccy Payment Notional Period Convention DCF Acc Start Acc End DF Cashflow NPV FX Rate Base Ccy NPV Ccy Collateral Rate Spread leg1 0 FixedPeriod USD 2001-01-04 1000000.0 Regular Act360 1.013889 2000-01-03 2001-01-02 None -10138.888889 None 1.0 USD None None 1.0 NaN 1 FixedPeriod USD 2002-01-04 1000000.0 Regular Act360 1.013889 2001-01-02 2002-01-02 None -10138.888889 None 1.0 USD None None 1.0 NaN 2 FixedPeriod USD 2003-01-06 1000000.0 Regular Act360 1.013889 2002-01-02 2003-01-02 None -10138.888889 None 1.0 USD None None 1.0 NaN leg2 0 FloatPeriod USD 2001-01-04 -1000000.0 Regular Act360 1.013889 2000-01-03 2001-01-02 None NaN None 1.0 USD None None NaN 0.0 1 FloatPeriod USD 2002-01-04 -1000000.0 Regular Act360 1.013889 2001-01-02 2002-01-02 None NaN None 1.0 USD None None NaN 0.0 2 FloatPeriod USD 2003-01-06 -1000000.0 Regular Act360 1.013889 2002-01-02 2003-01-02 None NaN None 1.0 USD None None NaN 0.0
Providing relevant pricing objects will ensure all data that can be calculated is returned.
In [3]: curve = Curve({dt(2000, 1, 1): 1.0, dt(2010, 1, 1): 0.75}) In [4]: irs.cashflows(curves=[curve]) Out[4]: Type Ccy Payment Notional Period Convention DCF Acc Start Acc End DF Cashflow NPV FX Rate Base Ccy NPV Ccy Collateral Rate Spread leg1 0 FixedPeriod USD 2001-01-04 1000000.0 Regular Act360 1.013889 2000-01-03 2001-01-02 0.971359 -10138.888889 -9848.496702 1.0 USD -9848.496702 None 1.000000 NaN 1 FixedPeriod USD 2002-01-04 1000000.0 Regular Act360 1.013889 2001-01-02 2002-01-02 0.943835 -10138.888889 -9569.435745 1.0 USD -9569.435745 None 1.000000 NaN 2 FixedPeriod USD 2003-01-06 1000000.0 Regular Act360 1.013889 2002-01-02 2003-01-02 0.916946 -10138.888889 -9296.817681 1.0 USD -9296.817681 None 1.000000 NaN leg2 0 FloatPeriod USD 2001-01-04 -1000000.0 Regular Act360 1.013889 2000-01-03 2001-01-02 0.971359 29161.694029 28326.461668 1.0 USD 28326.461668 None 2.876222 0.0 1 FloatPeriod USD 2002-01-04 -1000000.0 Regular Act360 1.013889 2001-01-02 2002-01-02 0.943835 29161.694029 27523.820438 1.0 USD 27523.820438 None 2.876222 0.0 2 FloatPeriod USD 2003-01-06 -1000000.0 Regular Act360 1.013889 2002-01-02 2003-01-02 0.916946 29161.694029 26739.710399 1.0 USD 26739.710399 None 2.876222 0.0
- Parameters:
curves (_Curves, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
solver (Solver, optional) – A
Solverobject containing Curve, Smile, Surface, or Cube mappings for pricing.fx (FXForwards, optional) – The
FXForwardsobject used for forecasting FX rates, if necessary.vol (_Vol, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
base (str, optional (set to settlement currency)) – The currency to convert the local settlement NPV to.
settlement (datetime, optional) – The assumed settlement date of the PV determination. Used only to evaluate ex-dividend status.
forward (datetime, optional) – The future date to project the PV to using the
disc_curve.
- Return type:
DataFrame
- cashflows_table(*, curves=NoInput.blank, solver=NoInput.blank, fx=NoInput.blank, vol=NoInput.blank, base=NoInput.blank, settlement=NoInput.blank, forward=NoInput.blank)#
Aggregate the values derived from a
cashflows(), grouped by date, settlement currency and collateral.Examples
In [5]: irs = IRS(dt(2000, 1, 1), "3Y", spec="usd_irs", fixed_rate=1.0) In [6]: curve = Curve({dt(2000, 1, 1): 1.0, dt(2010, 1, 1): 0.75}) In [7]: irs.cashflows_table(curves=[curve]) Out[7]: local_ccy USD collateral_ccy NaN payment 2001-01-04 19022.80514 2002-01-04 19022.80514 2003-01-06 19022.80514
- Parameters:
curves (_Curves, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
solver (Solver, optional) – A
Solverobject containing Curve, Smile, Surface, or Cube mappings for pricing.fx (FXForwards, optional) – The
FXForwardsobject used for forecasting FX rates, if necessary.vol (_Vol, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
base (str, optional (set to settlement currency)) – The currency to convert the local settlement NPV to.
local (bool, optional (set as False)) – An override flag to return a dict of NPV values indexed by string currency.
settlement (datetime, optional) – The assumed settlement date of the PV determination. Used only to evaluate ex-dividend status.
forward (datetime, optional) – The future date to project the PV to using the
disc_curve.
- Return type:
DataFrame
- delta(*, curves=NoInput.blank, solver=NoInput.blank, fx=NoInput.blank, vol=NoInput.blank, base=NoInput.blank, settlement=NoInput.blank, forward=NoInput.blank)#
Calculate delta risk of an Instrument against the calibrating instruments in a
Solver.Examples
In [8]: curve = Curve({dt(2000, 1, 1): 1.0, dt(2002, 1, 1): 0.85, dt(2010, 1, 1): 0.75}) In [9]: solver = Solver( ...: curves=[curve], ...: instruments=[ ...: IRS(dt(2000, 1, 1), "2Y", spec="usd_irs", curves=[curve]), ...: IRS(dt(2000, 1, 1), "5Y", spec="usd_irs", curves=[curve]), ...: ], ...: s=[2.0, 2.25], ...: instrument_labels=["2Y", "5Y"], ...: id="US_RATES" ...: ) ...: SUCCESS: `func_tol` reached after 6 iterations (levenberg_marquardt), `f_val`: 8.499591036903249e-16, `time`: 0.0032s In [10]: irs = IRS(dt(2000, 1, 1), "3Y", spec="usd_irs", curves=[curve]) In [11]: irs.delta(solver=solver) Out[11]: local_ccy usd display_ccy usd type solver label instruments US_RATES 2Y 129.580448 5Y 162.173287
- Parameters:
curves (_Curves, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
solver (Solver, required) – A
Solverobject containing Curve, Smile, Surface, or Cube mappings for pricing.fx (FXForwards, optional) – The
FXForwardsobject used for forecasting FX rates, if necessary.vol (_Vol, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
base (str, optional (set to settlement currency)) – The currency to convert the local settlement NPV to.
settlement (datetime, optional) – The assumed settlement date of the PV determination. Used only to evaluate ex-dividend status.
forward (datetime, optional) – The future date to project the PV to using the
disc_curve.
- Return type:
DataFrame
Notes
Delta measures the sensitivity of the PV to a change in any of the calibrating instruments of the given
Solver. Values are returned according to therate_scalarquantity at an Instrument level and according to themetricused to derive therate()method of each Instrument.
- exo_delta(*, curves=NoInput.blank, solver=NoInput.blank, fx=NoInput.blank, vol=NoInput.blank, base=NoInput.blank, settlement=NoInput.blank, forward=NoInput.blank, vars, vars_scalar=NoInput.blank, vars_labels=NoInput.blank)#
Calculate delta risk of an Instrument against some exogenous user created Variables, via a
Solver.See What are exogenous variables? in the cookbook.
Examples
This example calculates the risk of the fixed rate increasing by 1bp and the notional increasing by 1mm. Mathematically this should be equivalent to the npv and the analytic delta (although the calculation is based on AD and is completely independent of the solver).
In [12]: curve = Curve({dt(2000, 1, 1): 1.0, dt(2002, 1, 1): 0.85, dt(2010, 1, 1): 0.75}) In [13]: solver = Solver( ....: curves=[curve], ....: instruments=[ ....: IRS(dt(2000, 1, 1), "2Y", spec="usd_irs", curves=[curve]), ....: IRS(dt(2000, 1, 1), "5Y", spec="usd_irs", curves=[curve]), ....: ], ....: s=[2.0, 2.25], ....: instrument_labels=["2Y", "5Y"], ....: id="US_RATES" ....: ) ....: SUCCESS: `func_tol` reached after 6 iterations (levenberg_marquardt), `f_val`: 8.499591036903249e-16, `time`: 0.0030s In [14]: irs = IRS(dt(2000, 1, 1), "3Y", spec="usd_irs", fixed_rate=Variable(3.0, ["R"]), notional=Variable(1e6, ["N"]), curves=[curve]) In [15]: irs.exo_delta(solver=solver, vars=["R", "N"], vars_scalar=[1e-2, 1e6]) Out[15]: local_ccy usd display_ccy usd type solver label exogenous US_RATES R -291.752073 N -25123.690181 In [16]: irs.analytic_delta() Out[16]: <Dual: 291.752073, (N, 18da30, 18da31, ...), [0.0, 49.2, 239.9, ...]> In [17]: irs.npv() Out[17]: <Dual: -25123.690181, (N, R, 18da30, ...), [-0.0, -29175.2, 982218.9, ...]>
- Parameters:
curves (_Curves, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
solver (Solver, required) – A
Solverobject containing Curve, Smile, Surface, or Cube mappings for pricing.fx (FXForwards, optional) – The
FXForwardsobject used for forecasting FX rates, if necessary.vol (_Vol, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
base (str, optional (set to settlement currency)) – The currency to convert the local settlement NPV to.
settlement (datetime, optional) – The assumed settlement date of the PV determination. Used only to evaluate ex-dividend status.
forward (datetime, optional) – The future date to project the PV to using the
disc_curve.vars (list[str], required) – The variable tags which to determine sensitivities for.
vars_scalar (list[float], optional) – Scaling factors for each variable, for example converting rates to basis point etc. Defaults to ones.
vars_labels (list[str], optional) – Alternative names to relabel variables in DataFrames.
- Return type:
DataFrame
- gamma(*, curves=NoInput.blank, solver=NoInput.blank, fx=NoInput.blank, vol=NoInput.blank, base=NoInput.blank, settlement=NoInput.blank, forward=NoInput.blank)#
Calculate cross-gamma risk of an Instrument against the calibrating instruments of a
Solver.Examples
In [18]: curve = Curve({dt(2000, 1, 1): 1.0, dt(2002, 1, 1): 0.85, dt(2010, 1, 1): 0.75}) In [19]: solver = Solver( ....: curves=[curve], ....: instruments=[ ....: IRS(dt(2000, 1, 1), "2Y", spec="usd_irs", curves=[curve]), ....: IRS(dt(2000, 1, 1), "5Y", spec="usd_irs", curves=[curve]), ....: ], ....: s=[2.0, 2.25], ....: instrument_labels=["2Y", "5Y"], ....: id="US_RATES" ....: ) ....: SUCCESS: `func_tol` reached after 6 iterations (levenberg_marquardt), `f_val`: 8.499591036903249e-16, `time`: 0.0035s In [20]: irs = IRS(dt(2000, 1, 1), "3Y", spec="usd_irs", curves=[curve]) In [21]: irs.gamma(solver=solver) Out[21]: type instruments solver US_RATES label 2Y 5Y local_ccy display_ccy type solver label usd usd instruments US_RATES 2Y -0.029442 -0.038104 5Y -0.038104 -0.010190
- Parameters:
curves (_Curves, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
solver (Solver, required) – A
Solverobject containing Curve, Smile, Surface, or Cube mappings for pricing.fx (FXForwards, optional) – The
FXForwardsobject used for forecasting FX rates, if necessary.vol (_Vol, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
base (str, optional (set to settlement currency)) – The currency to convert the local settlement NPV to.
settlement (datetime, optional) – The assumed settlement date of the PV determination. Used only to evaluate ex-dividend status.
forward (datetime, optional) – The future date to project the PV to using the
disc_curve.
- Return type:
DataFrame
Notes
Gamma measures the second order cross-sensitivity of the PV to a change in any of the calibrating instruments of the given
Solver. Values are returned according to therate_scalarquantity at an Instrument level and according to themetricused to derive therate()method of each Instrument.
- local_analytic_rate_fixings(*, curves=NoInput.blank, solver=NoInput.blank, fx=NoInput.blank, vol=NoInput.blank, settlement=NoInput.blank, forward=NoInput.blank)#
Calculate the sensitivity to rate fixings of the Instrument, expressed in local settlement currency per basis point.
Examples
In [1]: curve1 = Curve({dt(2000, 1, 1): 1.0, dt(2010, 1, 1): 0.75}, id="Eur1mCurve") In [2]: curve3 = Curve({dt(2000, 1, 1): 1.0, dt(2010, 1, 1): 0.70}, id="Eur3mCurve") In [3]: irs = IRS(dt(2000, 1, 1), "20m", spec="eur_irs3", curves=[{"1m": curve1, "3m": curve3}, curve1]) In [4]: irs.local_analytic_rate_fixings() Out[4]: identifier Eur1mCurve Eur3mCurve local_ccy eur eur display_ccy eur eur frequency 1M 3M obs_dates 1999-12-30 8.81934 7.215824 2000-02-28 NaN 25.251470 2000-05-30 NaN 25.069179 2000-08-30 NaN 24.619619 2000-11-29 NaN 24.177105 2001-02-27 NaN 24.535960 2001-05-30 NaN 24.884455
- Parameters:
curves (_Curves, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
solver (Solver, optional) – A
Solverobject containing Curve, Smile, Surface, or Cube mappings for pricing.fx (FXForwards, optional) – The
FXForwardsobject used for forecasting FX rates, if necessary.vol (_Vol, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
settlement (datetime, optional) – The assumed settlement date of the PV determination. Used only to evaluate ex-dividend status.
forward (datetime, optional) – The future date to project the PV to using the
disc_curve.
- Return type:
DataFrame
Notes
This analytic method will index the sensitivities with series identifier according to the Curve id which has forecast the fixing.
- local_fixings(identifiers, scalars=NoInput.blank, curves=NoInput.blank, solver=NoInput.blank, fx=NoInput.blank, vol=NoInput.blank, settlement=NoInput.blank, forward=NoInput.blank)#
Calculate the sensitivity to fixings of the Instrument, expressed in local settlement currency.
- Parameters:
identifiers (Sequence of tuple[str, Series], required) – These are the series string identifiers and the data values that will be used in each Series to determine the sensitivity against.
scalars (Sequence of floats, optional (each set as 1.0)) – A sequence of scalars to multiply the sensitivities by for each on of the
identifiers.curves (_Curves, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
solver (Solver, optional) – A
Solverobject containing Curve, Smile, Surface, or Cube mappings for pricing.fx (FXForwards, optional) – The
FXForwardsobject used for forecasting FX rates, if necessary.vol (_Vol, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
settlement (datetime, optional) – The assumed settlement date of the PV determination. Used only to evaluate ex-dividend status.
forward (datetime, optional) – The future date to project the PV to using the
disc_curve.
- Return type:
DataFrame
- npv(*, curves=NoInput.blank, solver=NoInput.blank, fx=NoInput.blank, vol=NoInput.blank, base=NoInput.blank, local=False, settlement=NoInput.blank, forward=NoInput.blank)#
Calculate the NPV of the Instrument converted to any other base accounting currency.
Examples
In [1]: curve = Curve({dt(2000, 1, 1): 1.0, dt(2010, 1, 1): 0.75}) In [2]: irs = IRS(dt(2000, 1, 1), "3Y", spec="usd_irs", fixed_rate=1.0, curves=[curve]) In [3]: irs.npv() Out[3]: 53875.24237805192 In [4]: irs.npv(local=True) Out[4]: {'usd': 53875.24237805192}
- Parameters:
curves (_Curves, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
solver (Solver, optional) – A
Solverobject containing Curve, Smile, Surface, or Cube mappings for pricing.fx (FXForwards, optional) – The
FXForwardsobject used for forecasting FX rates, if necessary.vol (_Vol, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
base (str, optional (set to settlement currency)) – The currency to convert the local settlement NPV to.
local (bool, optional (set as False)) – An override flag to return a dict of NPV values indexed by string currency.
settlement (datetime, optional) – The assumed settlement date of the PV determination. Used only to evaluate ex-dividend status.
forward (datetime, optional) – The future date to project the PV to using the
disc_curve.
- Return type:
float, Dual, Dual2, Variable or dict of such indexed by string currency.
Notes
If
baseis not given then this function will return the value obtained from determining the PV in local settlement currency.If
baseis provided this then anFXForwardsobject may be required to perform conversions. AnFXRatesobject is also allowed for this conversion although best practice does not recommend it due to possible settlement date conflicts.
- rate(*, curves=NoInput.blank, solver=NoInput.blank, fx=NoInput.blank, vol=NoInput.blank, base=NoInput.blank, settlement=NoInput.blank, forward=NoInput.blank, metric=NoInput.blank)#
Calculate some pricing rate metric for the Instrument.
Examples
The default metric for an
IRSis its fixed ‘rate’.In [1]: curve = Curve({dt(2000, 1, 1): 1.0, dt(2010, 1, 1): 0.75}) In [2]: irs = IRS(dt(2000, 1, 1), "3Y", spec="usd_irs", curves=[curve], fixed_rate=2.0) In [3]: irs.rate() # <- `fixed_rate` on fixed leg to equate value with float leg Out[3]: 2.87622187684324
- Parameters:
curves (_Curves, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
solver (Solver, optional) – A
Solverobject containing Curve, Smile, Surface, or Cube mappings for pricing.fx (FXForwards, optional) – The
FXForwardsobject used for forecasting FX rates, if necessary.vol (_Vol, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
base (str, optional (set to settlement currency)) – The currency to convert the local settlement NPV to.
local (bool, optional (set as False)) – An override flag to return a dict of NPV values indexed by string currency.
settlement (datetime, optional) – The assumed settlement date of the PV determination. Used only to evaluate ex-dividend status.
forward (datetime, optional) – The future date to project the PV to using the
disc_curve.metric (str, optional) – The specific calculation to perform and the value to return. See Pricing on each Instrument for details of allowed inputs.
- Return type:
- reset_fixings(state=NoInput.blank)#
Resets any fixings values of the Instrument derived using the given data state.
- Parameters:
state (int, optional) – The state id of the data series that set the fixing. Only fixings determined by this data will be reset. If not given resets all fixings.
- Return type:
None
- spread(*, curves=NoInput.blank, solver=NoInput.blank, fx=NoInput.blank, vol=NoInput.blank, base=NoInput.blank, settlement=NoInput.blank, forward=NoInput.blank, metric=NoInput.blank)#
Calculate some pricing spread metric for the Instrument.
This calculation may be an alias for
rate()with a specific metric and is designated at an Instrument level.Examples
The ‘spread’ on an
IRSis the float leg spread to equate value with the fixed leg.In [1]: curve = Curve({dt(2000, 1, 1): 1.0, dt(2010, 1, 1): 0.75}) In [2]: irs = IRS(dt(2000, 1, 1), "3Y", spec="usd_irs", curves=[curve], fixed_rate=2.0) In [3]: irs.spread() # <- `spread` on float leg to equate value with fixed leg Out[3]: -87.62218768432399
- Parameters:
curves (_Curves, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
solver (Solver, optional) – A
Solverobject containing Curve, Smile, Surface, or Cube mappings for pricing.fx (FXForwards, optional) – The
FXForwardsobject used for forecasting FX rates, if necessary.vol (_Vol, optional) – Pricing objects. See Pricing on each Instrument for details of allowed inputs.
base (str, optional (set to settlement currency)) – The currency to convert the local settlement NPV to.
local (bool, optional (set as False)) – An override flag to return a dict of NPV values indexed by string currency.
settlement (datetime, optional) – The assumed settlement date of the PV determination. Used only to evaluate ex-dividend status.
forward (datetime, optional) – The future date to project the PV to using the
disc_curve.
- Return type: