Skip to main content

Matrices and options


Matrix​

A matrix is a two dimensional table of numbers with labelled rows and columns, for example a volatility surface or a set of hourly shapes by month. It is saved as a property of a master data object and read with the Data service.

FieldTypeRequiredWhat it is
_typeStringYesVarMatrix
_idStringNoThe data id within the object
ondateDateYesThe date of the matrix. A matrix is kept for each date, like a curve: NGE.GAS.TTF:VOL_SURFACE:2026-11-18
xLabelsString[]YesThe column labels
yLabelsString[]YesThe row labels
xSize, ySizeIntegerOutputThe number of columns and rows
dataNumber[][]YesOne list per row (in yLabels order), each with one number per column (in xLabels order). "NaN" for a missing value
name, descriptionStringNoDescriptive fields
currency, units, timezoneStringNoThe currency, units and timezone of the values
precisionObjectNoDecimal places and rounding, see Numbers
propertiesObjectNoYour own properties
_identityObjectNoThe codes other systems use for the matrix, by provider, see Identities
{
"_id": "VOL_SURFACE",
"_type": "VarMatrix",
"name": "TTF option volatility surface",
"ondate": "2026-11-18",
"units": "PCT",
"xLabels": ["80", "90", "100", "110", "120"],
"yLabels": ["M01", "M02", "Q01"],
"data": [
[58.2, 54.1, 51.7, 53.0, 56.4],
[55.0, 51.3, 49.2, 50.5, 53.8],
[49.6, 46.8, 45.1, 46.2, 48.9]
]
}

The platform also keeps the list of its dates (VarMatrixDates) under the id without the date, as it does for curves.


Event options​

An event options definition (VarEventOptions) builds option chains from an event list with one event per option. Only the definition is saved; the chains are built from the events when you read them. See Options data for what each setting does.

FieldTypeRequiredWhat it is
_typeStringYesVarEventOptions
eventStringYesThe event list, as objectid:eventlist
sourceStringNoWhere the events are: private, common or public
tenorStringNoThe event property with the tenor period code, defaults to absolute
strikeStringNoThe event property with the strike price, defaults to STRIKE_PRICE
callPutStringNoThe event property that says call or put, defaults to CONTRACT_TYPE
callValue, putValueStringNoThe values of callPut for a call and a put, default C and P
valueStringNoThe main value column, defaults to SETTLEMENT_PRICE
columnsString[]NoThe event properties shown for each call and put
filterStringNoA filter (JSON) on the events
timezoneStringNoThe timezone of the dates, defaults to UTC
holidayCalendarStringNoThe calendar of single option timeseries
calendarStringNoAn expiry calendar
currency, unitsStringNoThe currency and units of the prices
name, descriptionStringNoDescriptive fields
positions and the position... fieldsNoTurn the options into a positions view, see Traded options
propertiesObjectNoYour own properties

Saving a definition that has tenors is refused: the chains are never stored.

{
"_id": "OPTIONS",
"_type": "VarEventOptions",
"name": "EUA futures options",
"event": "ICE.NDEX.EFO:OPTIONS",
"source": "common",
"currency": "EUR",
"units": "t"
}

Option chains​

Reading event options for a date (for example NGE.EUA:OPTIONS:2026-09-16) returns the option chains for that date.

FieldTypeWhat it is
_typeStringVarOptions
_idStringThe id with the date
ondateDateThe date of the options
name, description, currency, units, timezoneStringFrom the definition
valueStringThe main value column
columnsString[]The columns of each call and put, in order
tenorsArrayThe tenors in delivery order: tenor, absolute and relative (the period codes), start, end (the delivery period), expiry and strikes
tenors[].strikesArrayThe strikes in ascending order: strike, and call and put with a value per column. A side with no option is left out
propertiesObjectFrom the definition, plus modified: when the latest event used was saved
_subtypeStringVarEventOptions
{
"_type": "VarOptions",
"_id": "NGE.EUA:OPTIONS:2026-09-16",
"ondate": "2026-09-16",
"name": "EUA futures options",
"currency": "EUR",
"units": "t",
"value": "SETTLEMENT_PRICE",
"columns": ["SETTLEMENT_PRICE", "OPTION_VOLATILITY", "DELTA_FACTOR", "OPEN_INTEREST", "TOTAL_VOLUME"],
"tenors": [
{
"tenor": "2026M09",
"absolute": "2026M09",
"relative": "M00",
"start": "2026-09-01",
"end": "2026-09-30",
"expiry": "2026-09-23",
"strikes": [
{
"strike": 85,
"call": {"SETTLEMENT_PRICE": 0.91, "OPTION_VOLATILITY": 22.0791, "DELTA_FACTOR": 0.4662, "OPEN_INTEREST": 3695, "TOTAL_VOLUME": 200},
"put": {"SETTLEMENT_PRICE": 1.05, "OPTION_VOLATILITY": 22.5, "DELTA_FACTOR": -0.5338, "OPEN_INTEREST": 1200}
}
]
}
],
"properties": {"event": "ICE.NDEX.EFO:OPTIONS", "modified": "2026-09-16T12:37:21"},
"_subtype": "VarEventOptions"
}

The list of dates for event options has the type VarOptionsDates.