LSEG Data Library for TypeScript

Built with Pandora

About Surfaces Cap

The Cap module allows constructing interest rate volatility surface using the caplets stripping volatility surface as the instrument type.

IPA.Surfaces.Cap.Definition object

This object defines the interest rate volatility surface parameters to construct.

Syntax

Surfaces.Cap.Definition(params: Surfaces.Cap.Params)

Parameters

Value Description Data type Optional Default value
params An object literal of type Surfaces.Cap.Params. object No -

Surfaces.Cap.Params properties:

Value Description Data type Optional Default value
instrumentCode The code to be applied to the volatility surface model. The value is a currency code and is expressed in ISO 4217 alphabetical format. string No -
discountingType The parameter for selecting the discounting curve and volatilities used to calibrate the model (See Cap.DiscountingType). enum Yes -
surfaceLayout The list of properties used to modify the layout of the volatility surface in outputs (See Cap.Layout). enum Yes -
surfaceTag A user-defined string to identify the volatility surface. It can be used to link output results to the requested definition. string Yes -
surfaceParameters The pricing parameters to be applied to the volatility surface (See Cap.CalculationParams). object Yes -
outputs The list of requested output analytics (See Cap.Outputs). enum Yes -
extendedParams Additional parameters to apply to the request. object Yes -

Returned value

ContentDefinition object.

Usage

The following example demonstrates how to create a definition for cap volatility surface with 'USD' currency code:

import { IPA } from '@lsegroup/data';

const definition = IPA.Surfaces.Cap.Definition({
    instrumentCode: 'USD',
});

`
219 words (1:09 mins)