getInstrumentNotionalAmount

Syntax

getInstrumentNotionalAmount(instrument)

Details

Get the notional principal amount of one or more instruments.

Parameters

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

Returns

A DOUBLE scalar or vector.

Examples

deposit =  {
    "productType": "Cash",
    "assetType": "Deposit",
    "start": 2025.05.15,
    "maturity": 2025.08.15,
    "rate": 0.02,
    "dayCountConvention": "Actual360",
    "notionalAmount":1E6,
    "notionalCurrency":"CNY",
    "payReceive": "Receive"
}
instrument = parseInstrument(deposit)
getInstrumentNotionalAmount(instrument)

// output: 1000000

Related functions: parseInstrument, getInstrumentField, getInstrumentKeys