getInstrumentNominalCouponRate

Syntax

getInstrumentNominalCouponRate(instrument)

Details

Get the nominal coupon rate of one or more instruments.

Arguments

instrument is a scalar or vector of the INSTRUMENT type, indicating one or more instruments.

Returns

A scalar or vector of the DOUBLE type.

Examples

futures =  {
    "productType": "Futures",
    "futuresType": "BondFutures",
    "version": 0,
    "instrumentId": "T2509",  
    "nominal": 100.0,
    "maturity": "2022.09.09",
    "settlement": "2022.09.11",
    "underlying": bond,
    "nominalCouponRate": 0.03  
}
instrument = parseInstrument(futures)
getInstrumentNominalCouponRate(instrument)

// output: 0.03

Related functions: parseInstrument, getInstrumentField, getInstrumentKeys