Spider Rock MLink home pagelight logodark logo
  • Contact us
  • SpiderRock
  • SpiderRock
API Documentation
  • Introduction
  • Messages
  • Authentication
Connection Types
  • MLink REST API
  • MLink Websocket API
Data Dictionary
  • Messages
Clients
  • Python
  • C++ and C#
Interactive Playground
  • Real Time
  • Delayed
Postman for WebSocket
  • Connection Guide
Data Dictionary

Messages

mTokenField NumberField NameField TypeField Description
MLinkRest100key1Stringbucket key for the 1st field in the ‘group’ clause
MLinkRest103key2Stringbucket key for the 2nd field in the ‘group’ clause
MLinkRest106key3Stringbucket key for the 3rd field in the ‘group’ clause
MLinkRest109key4Stringbucket key for the 4th field in the ‘group’ clause
MLinkRest112recCountInt
mTokenField NumberField NameField TypeField Description
MLinkRest100key1Stringbucket key for the 1st field in the ‘group’ clause
MLinkRest103key2Stringbucket key for the 2nd field in the ‘group’ clause
MLinkRest106key3Stringbucket key for the 3rd field in the ‘group’ clause
MLinkRest109key4Stringbucket key for the 4th field in the ‘group’ clause
MLinkRest112nameStringmeasure field name
MLinkRest115fNumUShort
MLinkRest118recCountInt
MLinkRest121errorString
MLinkRest124cntIntnumber of items in this composite bucket
MLinkRest127sumDouble
MLinkRest130avgDouble
MLinkRest133minDouble
MLinkRest136maxDouble
mTokenField NumberField NameField TypeField Description
MLinkRest100key1Stringbucket key for the 1st field in the ‘group’ clause
MLinkRest103key2Stringbucket key for the 2nd field in the ‘group’ clause
MLinkRest106key3Stringbucket key for the 3rd field in the ‘group’ clause
MLinkRest109key4Stringbucket key for the 4th field in the ‘group’ clause
MLinkRest112nameStringmeasure field name
MLinkRest115fNumUShort
MLinkRest118recCountInt
MLinkRest121errorString
MLinkRest124ValueRepeater
MLinkRest127valueString
MLinkRest130cntInt
mTokenField NumberField NameField TypeField Description
MLinkRest100nameStringfield name from the ‘group’ clause
MLinkRest103fNumUShort
MLinkRest106keyStringis one of key1, key2, key3, or key4 from an aggregate composite bucket result
MLinkRest109minStringbucket range is [min, max); might be an int, double, string, or datetime (all encoded as strings)
MLinkRest112maxString
MLinkRest115cntIntnumber of items in this bucket
mTokenField NumberField NameField TypeField Description
FutureDefinition10ccodeTickerKey
FutureDefinition100futexchEnumlisting exchange
FutureDefinition103tickerTickerKeymaster underlying
FutureDefinition106settleTimeEnumSettlement time: None; PM; AM
FutureDefinition109positionLimitIntmax contract limit
FutureDefinition112tickValueFloat$NLV value of a single tick change in display premium (pointValue = tickValue / tickSize)
FutureDefinition115pointValueFloat$NLV value of a single point change in display premium (pointValue = tickValue / tickSize)
FutureDefinition118pointCurrencyEnum
FutureDefinition121priceScalingFloatunderlying price scale factor - products where the underlying quotes in cents will have 0.01
FutureDefinition124underliersPerCnIntshares, bond, or index units underlying the future (contract size)
FutureDefinition127underlierTypeEnumUnderlying type; None; Equity; Other; FX
FutureDefinition130clearingCodeStringGMI/Clearing code
FutureDefinition133ricCodeStringRIC Code
FutureDefinition136bbgRootStringBloomberg root
FutureDefinition139bbgGroupEnumBloomberg Yellow Key
FutureDefinition142gmiExchangeStringGMI (Sungard) exchange code
FutureDefinition145gmiProductStringGMI (Sungard) product code
FutureDefinition148gmiSubTypeStringGMI (Sungard) subtype code
FutureDefinition151displayPriceScalingFloatinternal display price scale factor override
FutureDefinition154strikeScalingFloatinternal strike price scale factor override
FutureDefinition157descriptionStringproduct description
FutureDefinition160marketCenterStringmarket center, eg “ICE Market Type”, “CME MarketGroup”
FutureDefinition163timestampDateTime
mTokenField NumberField NameField TypeField Description
MLinkRest100posUShortposition in message (1…N)
MLinkRest103nameStringfield name
MLinkRest106fNumUShortprotobuf field number
MLinkRest109isPkeyEnumYesNo enum (if field is a primary key)
MLinkRest112inRepeaterStringif field is in a repeating group, the repeater’s name
MLinkRest115fTypeEnumField Type
MLinkRest118jsonEncTypeStringoverriden type specifically for JSON encoding
MLinkRest121protoEncTypeStringoverriden type specifically for protobuf encoding
MLinkRest124sLenUShortstring length (if fType is string)
MLinkRest127eNameStringenum name (if fType is enum)
MLinkRest130eSetText2comma separated list of enum or string values (can be specific for a given user; default complete set)
MLinkRest133defaultValStringfrom Core.def: (…) can be a string, number, xKey, or partial xKey
MLinkRest136descText2from core.def: … # comment line
MLinkRest139fCtrlEnumNone = should not be visible; View = view only; Edit = View/Edit; Hide = Suppress on UI (form level directive)
MLinkRest142minVDoubleform edit number range min bound (if field is a numeric type) [enforced on edit]
MLinkRest145maxVDoubleform edit number range max bound (if field is a numeric type) [enforced on edit]
MLinkRest148metaTypeStringmetatype associated with field
MLinkRest151labelText2column (grid) and widget (form) label
MLinkRest154groupText2form flow groups
MLinkRest157formatText2numeric format string (eg. ’#,###.00’) (both grid and form)
MLinkRest160cColorBytegrid column color number (color palette number) (0 means undefined)
MLinkRest163contextQueryText2`context query for pseudo enum fields with format of contextQuery= otherMsgTypeselectFieldcontextFieldcontextField…contextField`
mTokenField NumberField NameField TypeField Description
FutMktData10fkeyExpiryKey
FutMktData100updateTypeEnum
FutMktData103marketStatusEnummarket status (open, halted, etc)
FutMktData106bidPrice1Doublebid price
FutMktData109askPrice1Doubleask price
FutMktData112bidSize1Intbid size in contracts
FutMktData115askSize1Intask size in contracts
FutMktData118bidOrders1UShortnumber of participating orders at the bid price
FutMktData121askOrders1UShortnumber of participating orders at the ask price
FutMktData124bidPrice2Doublebid price
FutMktData127askPrice2Doubleask price
FutMktData130bidSize2Intbid size in contracts
FutMktData133askSize2Intask size in contracts
FutMktData136bidOrders2UShortnumber of participating orders at the bid price
FutMktData139askOrders2UShortnumber of participating orders at the ask price
FutMktData142bidPrice3Doublebid price
FutMktData145askPrice3Doubleask price
FutMktData148bidSize3Intbid size in contracts
FutMktData151askSize3Intask size in contracts
FutMktData154bidOrders3UShortnumber of participating orders at the bid price
FutMktData157askOrders3UShortnumber of participating orders at the ask price
FutMktData160bidPrice4Doublebid price
FutMktData163askPrice4Doubleask price
FutMktData166bidSize4Intbid size in contracts
FutMktData169askSize4Intask size in contracts
FutMktData172bidOrders4UShortnumber of participating orders at the bid price
FutMktData175askOrders4UShortnumber of participating orders at the ask price
FutMktData178srcTimestampLongsource high precision timestamp (if available)
FutMktData181netTimestampLonginbound packet PTP timestamp from SR gateway switch;usually syncronized with facility grandfather clock
mTokenField NumberField NameField TypeField Description
FutMarkData10fkeyExpiryKey
FutMarkData100tradeDateDateKey
FutMarkData103clsMarkStateEnumClose mark state: None; LastPrt; SRClose; ExchClose; Final
FutMarkData106opnPrcDoubleOpening price
FutMarkData109minPrcDoubleLow price
FutMarkData112maxPrcDoubleHigh Price
FutMarkData115openInterestIntOpen interest
FutMarkData118prtCountIntprint count
FutMarkData121prtVolumeIntprint volume
FutMarkData124realizedCntIntnumber of minute bar segments used in realizedVar calc
FutMarkData127realizedVarFloatrealizedVar = SUM[ LOG( qteTwap(T) / qteTwap(T+1) ) ^ 2 ] / realizedCnt @ 1 minute intervals during market hours
FutMarkData130avgMktSizeFloatMEAN[0.5 * (bidSize + askSize) ] @ 1 minute intervals during market hours
FutMarkData133avgMktWidthFloatMEAN[ askPrice - bidPrice ] @ 1 minute intervals during market hours
FutMarkData136bidPrcDoublebid price (close - 1min)
FutMarkData139askPrcDoubleask price (close - 1min)
FutMarkData142srClsPrcDoublesr close mark (close - 1min)
FutMarkData145closePrcDoubleofficial exchange closing mark (last print;then official close)
FutMarkData148hasSRClsPrcEnum
FutMarkData151hasClosePrcEnum
FutMarkData154srCloseMarkDttmDateTimefrom MarketCloseQuote.srCloseMarkDttm
FutMarkData157timestampDateTime
mTokenField NumberField NameField TypeField Description
FutSummaryData10fkeyExpiryKey
FutSummaryData100opnPriceDoublefirst print price of the day during regular market hours
FutSummaryData103mrkPriceDoublelast print handled during regular market hours
FutSummaryData106clsPriceDoubleofficial exchange closing price
FutSummaryData109minPriceDoubleminimum print price within market hours
FutSummaryData112maxPriceDoublemaximum print price within market hours
FutSummaryData115openIntIntopen interest
FutSummaryData118bidCountIntnum prints less than or equals to quote.bid
FutSummaryData121bidVolumeIntvolume when prtPrice less than or equals to quote.bid
FutSummaryData124askCountIntnum prints greater than or equals to quote.ask
FutSummaryData127askVolumeIntvolume when prtPrice greater than or equals to quote.ask
FutSummaryData130midCountIntnum prints inside quote.bid / quote.ask
FutSummaryData133midVolumeIntvolume inside quote.bid / quote.ask
FutSummaryData136prtCountIntnumber of distinct print reports
FutSummaryData139prtPriceDoublelast print price
FutSummaryData142expCountIntnumber of updates included in exponential average
FutSummaryData145expWidthDoubleexponential average market width (10 minute 1/2 life)
FutSummaryData148expBidSizeFloatexponential average bid size (10 minute 1/2 life)
FutSummaryData151expAskSizeFloatexponential average ask size (10 minute 1/2 life)
FutSummaryData154lastPrintDateTime
FutSummaryData157timestampDateTime
mTokenField NumberField NameField TypeField Description
FutSummaryData10fkeyExpiryKey
FutSummaryData100dateStringTrade Date
FutSummaryData103timeStringTrade Time end of period (Bar)
FutSummaryData106prtOpenDoublePrint at open of period (Bar)
FutSummaryData109prtHighDoubleHigh price during period (Bar)
FutSummaryData112prtLowDoubleLow price during period (Bar)
FutSummaryData115prtLastDoublePrint at close of period (Bar)
FutSummaryData118prtVWapDoublePeriod (Bar) VWap
FutSummaryData121prtVolumeIntPeriod (Bar) number of contracts
FutSummaryData124prtCountIntNumber of prints during the period
FutSummaryData127qteHiBidDoubleQuote bid high
FutSummaryData130qteLoAskDoubleQuote ask low
FutSummaryData133qteTwapDoubleQuote Twap
FutSummaryData136qteCountIntQuote number of contracts
FutSummaryData139bidDoubleBid at the time of the print
FutSummaryData142askDoubleAsk at the time of the print
FutSummaryData145bidSzIntBid size at the time of print
FutSummaryData148askSzIntAsk size at the time of print
FutSummaryData151widthFloatreference point for expWidth (SR debug use)
FutSummaryData154isEOBEnumis end-of-bar (every 10 minutes)
FutSummaryData157isEOHEnumis end-of-hour
FutSummaryData160timestampDateTimesame as date + time
mTokenField NumberField NameField TypeField Description
FutMarkData10fkeyExpiryKey
FutMarkData100tradeDateDateKey
FutMarkData103srClsPrcDoubleSR open mark; [SR close mark (close - 1min) from previous day]
FutMarkData106closePrcDoubleexchange open mark; [exchange close mark from previous day]
FutMarkData109bidPrcDoublebid price (SR bid price from previous day)
FutMarkData112askPrcDoubleask price (SR ask price from previous day)
FutMarkData115timestampDateTime
mTokenField NumberField NameField TypeField Description
FutMktData10fkeyExpiryKey
FutMktData100prtExchEnumprint exchange
FutMktData103prtSizeIntprint size [contracts]
FutMktData106prtPriceDoubleprint price
FutMktData109prtClusterNumIntincremental print cluster counter (one counter per fkey; used to group prints into clusters)
FutMktData112prtClusterSizeIntcumulative size of prints in this sequence (sequence of prints @ same or better price with less than 25 ms elapsing since first print)
FutMktData115prtTypeByteprint type [exchange specific]
FutMktData118prtOrdersUShortnumber of orders participating in this print
FutMktData121prtQuanIntcumulative (electronic) print size at current price level
FutMktData124prtVolumeIntcumulative day (electronic) print volume in contracts
FutMktData127bidFloatexchange bid (@ print time)
FutMktData130askFloatexchange ask (@ print time)
FutMktData133bszIntcumulative bid size (@ print time)
FutMktData136aszIntcumulative ask size (@ print time)
FutMktData139ageFloatage of prevailing quote at time of print
FutMktData142prtSideEnumimplied print side (from bid/ask)
FutMktData145prtTimestampLongexchange high precision timestamp (if available)
FutMktData148netTimestampLonginbound packet PTP timestamp from SR gateway switch;usually syncronized with facility grandfather clock
FutMktData151timestampDateTime
mTokenField NumberField NameField TypeField Description
FutProbModel10fkeyExpiryKey
FutProbModel11stateModelEnum
FutProbModel100prtPriceDouble
FutProbModel103prtSizeInt
FutProbModel106prtProbFloatprobability that this print will result in positive PnL
FutProbModel109prtSideEnum
FutProbModel112bidPriceDoublenbbo bid price
FutProbModel115askPriceDoublenbbo ask price
FutProbModel118bidSizeIntcumulative size @ bid price
FutProbModel121askSizeIntcumulative size @ ask price
FutProbModel124avgBLink1mFloataverage buy link value (trailing 10)
FutProbModel127maeBLink1mFloatbuy link value mean abs err (trailing 1000)
FutProbModel130avgSLink1mFloataverage sell link value (trailing 10)
FutProbModel133maeSLink1mFloatsell link value mean abs err (trailing 1000)
FutProbModel136avgBLink10mFloataverage buy link value (trailing 100)
FutProbModel139maeBLink10mFloatbid link value mean abs err (trailing 1000)
FutProbModel142avgSLink10mFloataverage ask link value (trailing 100)
FutProbModel145maeSLink10mFloatask link value mean abs err (trailing 1000)
FutProbModel148bCounterIntbuy counter
FutProbModel151sCounterIntsell counter
FutProbModel154prtTimestampLongfeed timestamp from the packet
FutProbModel157netTimestampLonginbound packet PTP timestamp from SR gateway switch (from FuturePrint)
FutProbModel160smsTimestampLongstate model server timestamp (just before publish)
mTokenField NumberField NameField TypeField Description
FutProbModel10fkeyExpiryKey
FutProbModel11stateModelEnum
FutProbModel100bidPriceDoublebest bid price
FutProbModel103askPriceDoublebest ask price
FutProbModel106bidSizeIntcumulative size @ bid price
FutProbModel109askSizeIntcumulative size @ ask price
FutProbModel112bidTakeProbFloatbid take probability of current nbbo market (zero exchange fee) [average size print]
FutProbModel115askTakeProbFloatask take probability of current nbbo market (zero exchange fee) [average size print]
FutProbModel118bidTakeRvEnummodel result code
FutProbModel121askTakeRvEnummodel result code
FutProbModel124bidImprPriceFloattrial improvement price (usually 1 tick or 1/2 spread inside bidPrice)
FutProbModel127askImprPriceFloattrial improvement price (usually 1 tick or 1/2 spread inside askPrice)
FutProbModel130bidTkImProbFloatbid take imprv probability of current nbbo market (zero exchange fee) [prob to sell (take) @ bid + imprIncrement]
FutProbModel133askTkImProbFloatask take imprv probability of current nbbo market (zero exchange fee) [prob to buy (take) @ ask - imprIncrement]
FutProbModel136bidTkImRvEnummodel result code
FutProbModel139askTkImRvEnummodel result code
FutProbModel142midPriceDoubleprice corresponding to 0.50 probability
FutProbModel145avgBidLink1mFloataverage bid link value (~1 min)
FutProbModel148maeBidLink1mFloatbid link value mean abs err (~10 min)
FutProbModel151avgAskLink1mFloataverage ask link value (~1 min)
FutProbModel154maeAskLink1mFloatask link value mean abs err (~1 min)
FutProbModel157avgBidLink10mFloataverage bid link value (~10 min)
FutProbModel160maeBidLink10mFloatbid link value mean abs err (~10 min)
FutProbModel163avgAskLink10mFloataverage ask link value (~10 min)
FutProbModel166maeAskLink10mFloatask link value mean abs err (~10 min)
FutProbModel169avgMktWidth1mFloataskPrice - bidPrice (~1 min)
FutProbModel172avgMktWidth10mFloataskPrice - bidPrice (~10 min)
FutProbModel175counterIntrecord update counter (zero @ start of period;per fkey)
FutProbModel178qpSourceEnum
FutProbModel181srcTimestampLongfeed timestamp from the packet
FutProbModel184netTimestampLonginbound packet PTP timestamp from SR gateway switch (from FutureBookQuote);zero = size only change
FutProbModel187smsTimestampLongstate model server timestamp (just before publish)
mTokenField NumberField NameField TypeField Description
RiskCalc100rootTickerKey
RiskCalc103expiryDateKey
RiskCalc106strikeDouble
RiskCalc109callPutEnum
RiskCalc112volDoublevolatility (will be SR surface volatility if not supplied)
RiskCalc115uPrcDoubleunderlying price
RiskCalc118yearsDoubleyears-to-expiration (default uses SR volatility time value)
RiskCalc121sdivDoublecontinuous stock dividend using for pricing
RiskCalc124rateDoublediscount rate used for pricing
RiskCalc127exTypeEnumexercise type of the option (American or European)
RiskCalc130exTimeEnumexercise time (AM or PM)
RiskCalc133timeMetricEnumtime metric (D252, D365, etc.)
RiskCalc145modelTypeEnum
RiskCalc148calcEngineEnumunderlying calc engine: FastHybrid (listed strikes + SR discrtete dividends only). NumericX works for any strike/expiry + discrete dividend set but is significantly slower.
RiskCalc151incGreeksEnumdefault (No)
RiskCalc154priceDoubleprice (premium)
RiskCalc157effStrikeDoubleeffective strike used to for pricing calc
RiskCalc160dividendAmountFloatsum of discrete dividend amounts payable prior to exercise (if any) (simple; not net present value)
RiskCalc163deltaFloatdelta
RiskCalc166gammaFloatgamma
RiskCalc169thetaFloattheta
RiskCalc172vegaFloatvega
RiskCalc175volgaFloatvolga
RiskCalc178vannaFloatvanna
RiskCalc181deDecayFloatdelta decay
RiskCalc184rhoFloatrho
RiskCalc187phiFloatphi
RiskCalc190errorString
RiskCalc193pricerModelString
RiskCalc196timestampDateTime
RiskCalc136DiscreteDividendRepeater
RiskCalc139dateDateTime
RiskCalc142amountFloat
mTokenField NumberField NameField TypeField Description
RiskCalc100rootTickerKey
RiskCalc103expiryDateKey
RiskCalc106strikeDouble
RiskCalc109callPutEnum
RiskCalc112priceDoubleoption price (premium)
RiskCalc115uPrcDoubleunderlying price
RiskCalc118yearsDoubleyears-to-expiration (default uses SR volatility time value)
RiskCalc121sdivDoublecontinuous stock dividend using for pricing
RiskCalc124rateDoublediscount rate used for pricing
RiskCalc127exTypeEnumexercise type of the option (American or European)
RiskCalc130exTimeEnumexercise time (AM or PM)
RiskCalc133timeMetricEnumtime metric (D252, D365, etc.)
RiskCalc145modelTypeEnum
RiskCalc148calcEngineEnumunderlying calc engine: FastHybrid (listed strikes + SR discrtete dividends only). NumericX works for any strike/expiry + discrete dividend set but is significantly slower.
RiskCalc151incGreeksEnumdefault (No)
RiskCalc154volDoublevolatility (implied)
RiskCalc157effStrikeDoubleeffective strike used to for pricing calc
RiskCalc160dividendAmountFloatsum of discrete dividend amounts payable prior to exercise (if any) (simple; not net present value)
RiskCalc163deltaFloatdelta
RiskCalc166gammaFloatgamma
RiskCalc169thetaFloattheta
RiskCalc172vegaFloatvega
RiskCalc175volgaFloatvolga
RiskCalc178vannaFloatvanna
RiskCalc181deDecayFloatdelta decay
RiskCalc184rhoFloatrho
RiskCalc187phiFloatphi
RiskCalc190errorString
RiskCalc193pricerModelString
RiskCalc196timestampDateTime
RiskCalc136DiscreteDividendRepeater
RiskCalc139dateDateTime
RiskCalc142amountFloat
mTokenField NumberField NameField TypeField Description
GlobalDefinition10tickerTickerKey
GlobalDefinition100timestampDateTimepublish time (GlobalDividend.timestamp = SRPricingCalcRecord.timestamp @ publish)
GlobalDefinition103lastModifiedDateTimelast dividend data modify timestamp
GlobalDefinition106textText1extra text (if any)
GlobalDefinition109DateAmtRepeater
GlobalDefinition112divDateDateKeyex-dividend date
GlobalDefinition115divValueFloatdividend amount
GlobalDefinition118divCurrencyString
GlobalDefinition121divKindEnumdividend type
GlobalDefinition124divSourceEnumdividend source
GlobalDefinition127divFreqEnum
GlobalDefinition130divOverrideSourceEnumdividend override source if any
mTokenField NumberField NameField TypeField Description
GlobalDefinition10rateSourceEnum
GlobalDefinition100timestampDateTime
GlobalDefinition103CurveRepeater
GlobalDefinition106daysIntcalendar days to expiration (actual/365 days per year)
GlobalDefinition109rateFloat
mTokenField NumberField NameField TypeField Description
OptSurface10tickerTickerKey
OptSurface11windowTypeStringeg. cc, ccCen, ccClCen, hl, hlCen, iv63, iv126, etc
OptSurface100dateStringmost recent closing date
OptSurface103securityIDInt
OptSurface106valueFloatmost recent historical value
OptSurface109mv_5dFloathistorical mean value (5 day window)
OptSurface112sd_5dFloathistorical std dev (5 day window)
OptSurface115mv_10dFloat
OptSurface118sd_10dFloat
OptSurface121mv_21dFloat
OptSurface124sd_21dFloat
OptSurface127mv_42dFloat
OptSurface130sd_42dFloat
OptSurface133mv_63dFloat
OptSurface136sd_63dFloat
OptSurface139mv_84dFloat
OptSurface142sd_84dFloat
OptSurface145mv_105dFloat
OptSurface148sd_105dFloat
OptSurface151mv_126dFloat
OptSurface154sd_126dFloat
OptSurface157mv_189dFloat
OptSurface160sd_189dFloat
OptSurface163mv_252dFloat
OptSurface166sd_252dFloat
OptSurface169mv_378dFloat
OptSurface172sd_378dFloat
OptSurface175mv_504dFloat
OptSurface178sd_504dFloat
OptSurface181timestampDateTimerecord update timestamp
mTokenField NumberField NameField TypeField Description
OptSurface10ekeyExpiryKey
OptSurface100tickerTickerKeyunderlying tickerKey (stock or product group) that this option expiration is associated with
OptSurface103uPrcDoubleeffective underlier price
OptSurface106yearsFloatSR years to expiry metric
OptSurface109rateFloataverage expected interest rate to expiry (SR global rate curve)
OptSurface112ddivFloat(expected) cumulative discrete dividend $ amounts prior to expiration (if any)
OptSurface115ddivPvFloat(expected) cumulative npv of discrete dividend $ amounts prior to expiration (SR global rate curve) (if any)
OptSurface118ddivSourceEnumForecast if any of the dividends prior to expiry are forecast rather than announced
OptSurface121atmVolFloatatm vol (xAxis = 0)
OptSurface124atmEMAFloatatm vol exp moving average (half-life ~ 30 seconds)
OptSurface127uPrcRatioDoubleuPrc = uPrcDriver * uPrcRatio (when priceType = Future); uPrc = uPrcDriver (when priceType = Equity)
OptSurface130uPrcRatioEMADoubletime smoothed implied uPrcRatio (half-life ~ 30 seconds)
OptSurface133sdivFloatstock dividend (borrow rate) (derived from call/put balance when priceType=Stock; =rate otherwise)
OptSurface136sdivEMAFloatsdiv exp moving average (half-life ~ 30 seconds)
OptSurface139minCPAdjValDoubleminimum cpAdjVal (sdiv or uPrcRatio)
OptSurface142maxCPAdjValDoubleminimum cpAdjVal (sdiv or uPrcRatio)
OptSurface145cpAdjTypeEnumadjustment used to align calls/puts
OptSurface148priceTypeEnum[Equity] has independent uPrc and rate with sdiv derived from call/put balance; [Future] has sdiv = rate with uPrc’ derived from call/put balance
OptSurface151uPrcDriverKeyExpiryKeyunderlier driver key
OptSurface154uPrcDriverTypeEnumunderlier driver key type (stock or future)
OptSurface157uPrcDriverDoubleunderlier driver (mid-market)
OptSurface160axisFUPrcFloatforward underlier price; also at-the-money (xAxis = 0) synthetic strike
OptSurface163synSpotDoubleSynthetic spot price (market-derived spot when the underlying is not a traded instrument)
OptSurface166vWidthFloatatm volatility market width (estimated from near expiries)
OptSurface169numAtmStrikesByte
OptSurface172tradeableStatusEnumindicates whether the surface is currently tradeable or not (all server surface integrity checks pass)
OptSurface175surfaceResultEnum
OptSurface178netTimestampLongmost recent unix timestamp (all option quotes)
OptSurface181timestampDateTime
mTokenField NumberField NameField TypeField Description
OptSurface10ekeyExpiryKey
OptSurface100tickerTickerKeyunderlying tickerKey (stock or product group) that this option expiration is associated with
OptSurface103uPrcDoubleeffective underlier price
OptSurface106yearsFloatSR years to expiry metric
OptSurface109rateFloataverage expected interest rate to expiry (SR global rate curve)
OptSurface112ddivFloat(expected) cumulative discrete dividend $ amounts prior to expiration (if any)
OptSurface115ddivPvFloat(expected) cumulative npv of discrete dividend $ amounts prior to expiration (SR global rate curve) (if any)
OptSurface118ddivSourceEnumForecast if any of the dividends prior to expiry are forecast rather than announced
OptSurface121atmVolFloatatm vol (xAxis = 0)
OptSurface124atmEMAFloatatm vol exp moving average (half-life ~ 30 seconds)
OptSurface127uPrcRatioDoubleuPrc = uPrcDriver * uPrcRatio (when priceType = Future); uPrc = uPrcDriver (when priceType = Equity)
OptSurface130uPrcRatioEMADoubletime smoothed implied uPrcRatio (half-life ~ 30 seconds)
OptSurface133sdivFloatstock dividend (borrow rate) (derived from call/put balance when priceType=Stock; =rate otherwise)
OptSurface136sdivEMAFloatsdiv exp moving average (half-life ~ 30 seconds)
OptSurface139minCPAdjValDoubleminimum cpAdjVal (sdiv or uPrcRatio)
OptSurface142maxCPAdjValDoubleminimum cpAdjVal (sdiv or uPrcRatio)
OptSurface145cpAdjTypeEnumadjustment used to align calls/puts
OptSurface148priceTypeEnum[Equity] has independent uPrc and rate with sdiv derived from call/put balance; [Future] has sdiv = rate with uPrc’ derived from call/put balance
OptSurface151uPrcDriverKeyExpiryKeyunderlier driver key
OptSurface154uPrcDriverTypeEnumunderlier driver key type (stock or future)
OptSurface157uPrcDriverDoubleunderlier driver (mid-market)
OptSurface160axisFUPrcFloatforward underlier price; also at-the-money (xAxis = 0) synthetic strike
OptSurface163spotUPrcDoublespotUPrc = uPrc if priceType = Equity; spotUPrc != uPrc priceType = Future
OptSurface166vWidthFloatatm volatility market width (estimated from near expiries)
OptSurface169numAtmStrikesByte
OptSurface172tradeableStatusEnumindicates whether the surface is currently tradeable or not (all server surface integrity checks pass)
OptSurface175surfaceResultEnum
OptSurface178netTimestampLongmost recent unix timestamp (all option quotes)
OptSurface181timestampDateTime
mTokenField NumberField NameField TypeField Description
OptAnalytics10okeyOptionKey
OptAnalytics100tickerTickerKeySR Ticker that this option rolls up to
OptAnalytics103uPrcFloatunderlier price (usually mid-market)
OptAnalytics106uOffFloatimplied underlier price offset (if any)
OptAnalytics109yearsFloatyears to expiration
OptAnalytics112xAxisFloatoption moneyness
OptAnalytics115rateFloatdiscount rate
OptAnalytics118sdivFloatsdiv (continuous stock dividend) rate
OptAnalytics121ddivFloatcumulative discrete dividend value
OptAnalytics124oBidFloatoption bid price
OptAnalytics127oAskFloatoption ask price
OptAnalytics130oBidIvFloatvolatility implied by option bid price
OptAnalytics133oAskIvFloatvolatility implied by option ask price
OptAnalytics136atmVolFloatoption atm volatility (from SR surface)
OptAnalytics139sVolFloatoption surface volatility (SR surface fit model)
OptAnalytics142sPrcFloatoption surface price; ie. PRICE(sVol, uPrc + uOff, years, rate, sDiv, {discrete dividends, if any})
OptAnalytics145sMarkFloatoption surface mark (option surface price w/bounding rules; always between bid/ask)
OptAnalytics148veSlopeFloatveSlope = dVol / dUprc (assuming vol @ xAxis = 0 remains constant); hedgeDelta = (de + ve * 100 * veSlope) if hedging with this assumption
OptAnalytics151deFloatoption delta
OptAnalytics154gaFloatoption gamma
OptAnalytics157thFloatoption theta
OptAnalytics160veFloatoption vega
OptAnalytics163vaFloatoption vanna
OptAnalytics166voFloatoption volga
OptAnalytics169roFloatoption rho
OptAnalytics172phFloatoption phi
OptAnalytics175deDecayFloatoption delta decay
OptAnalytics178up50Floatunderlier up 50% slide
OptAnalytics181dn50Floatunderlier dn 50% slide
OptAnalytics184up15Floatunderlier up 15% slide
OptAnalytics187dn15Floatunderlier dn 15% slide
OptAnalytics190up06Floatunderlier up 6% slide
OptAnalytics193dn08Floatunderlier dn 8% slide
OptAnalytics196synSpotDoubleSynthetic spot price (market-derived spot when the underlying is not a traded instrument)
OptAnalytics199priceTypeEnumEquity or Future (Black76) pricing framework; if Future then uPrc is the forwardUPrc and sdiv = rate
OptAnalytics202calcErrEnumoption pricing calculation error (if any)
OptAnalytics205calcSourceEnum
OptAnalytics208srcTimestampLongOPRA source timestamp (nanoseconds since epoch); will be zero if calcSource != Tick
OptAnalytics211netTimestampLongSR timestamp @ publish time
OptAnalytics214timestampDateTime
mTokenField NumberField NameField TypeField Description
OptAnalytics10okeyOptionKey
OptAnalytics100tickerTickerKey
OptAnalytics103uprcFloatunderlier price (usually mid-market)
OptAnalytics106yearsFloatyears to expiration
OptAnalytics109rateFloatinterest rate
OptAnalytics112sdivFloatsdiv (stock dividend) rate
OptAnalytics115ddivFloatcumulative discrete dividend values
OptAnalytics118obidFloatoption bid price
OptAnalytics121oaskFloatoption ask price
OptAnalytics124obivFloatvolatility implied by option bid price
OptAnalytics127oaivFloatvolatility implied by option ask price
OptAnalytics130satmFloatoption atm volatility (from SR surface)
OptAnalytics133smnyFloatoption moneyness
OptAnalytics136svolFloatoption surface volatility
OptAnalytics139sprcFloatoption surface price
OptAnalytics142smrkFloatoption surface price (w/bounding rules)
OptAnalytics145veSlopeFloatveSlope = dVol / dUprc (assuming vol @ xAxis = 0 remains constant);hedgeDelta = (de + ve * 100 * veSlope) if hedging with this assumption
OptAnalytics148deFloatoption delta
OptAnalytics151gaFloatoption gamma
OptAnalytics154thFloatoption theta
OptAnalytics157veFloatoption vega
OptAnalytics160vaFloatoption vanna
OptAnalytics163voFloatoption volga
OptAnalytics166roFloatoption rho
OptAnalytics169phFloatoption phi
OptAnalytics172deDecayFloatoption delta decay
OptAnalytics175up50Floatunderlier up 50% slide
OptAnalytics178dn50Floatunderlier dn 50% slide
OptAnalytics181up15Floatunderlier up 15% slide
OptAnalytics184dn15Floatunderlier dn 15% slide
OptAnalytics187up06Floatunderlier up 6% slide
OptAnalytics190dn08Floatunderlier dn 8% slide
OptAnalytics193synSpotDoubleSynthetic spot price (market-derived spot when the underlying is not a traded instrument)
OptAnalytics196priceTypeEnumEquity or Future (Black76) pricing framework; if Future then uPrc is the forwardUPrc and sdiv = rate
OptAnalytics199calcErrStringoption pricing error (if any)
OptAnalytics202calcSourceEnum
OptAnalytics205uPrcAdjResultEnum
OptAnalytics208timestampDateTime
mTokenField NumberField NameField TypeField Description
OptSurface10ekeyExpiryKey
OptSurface11surfaceTypeEnum
OptSurface100tickerTickerKeyunderlying stock key that this option expiration attaches to
OptSurface103fkeyExpiryKeyunderlying future key (if any)
OptSurface106uPrcDriverKeyExpiryKeyunderlier driver key
OptSurface109uPrcDriverTypeEnumunderlier driver key type (stock or future)
OptSurface112uPrcDriverDoubleunderlier driver (mid-market)
OptSurface115uPrcDoubleeffective uPrc used for surface fitting
OptSurface118uBidDoubleeffective uBid
OptSurface121uAskDoubleeffective uAsk
OptSurface124yearsFloattime to expiration (in years)
OptSurface127rateFloataverage interest rate to expiration (SR global rate curve)
OptSurface130sdivFloatstock dividend (borrow rate)
OptSurface133ddivFloat(expected) cumulative discrete dividend $ amounts prior to expiration
OptSurface136ddivPvFloat(expected) cumulative npv of discrete dividend $ amounts prior to expiration (SR global rate curve)
OptSurface139ddivSourceEnumForecast if any of the dividends prior to expiry are forecast rather than announced
OptSurface142symbolRatioFloatunderlier price ratio (usually 1.0 or a multi-hedge option price ratio; if one exists)
OptSurface145exTypeEnumexercise type (American or European)
OptSurface148modelTypeEnumoption pricing model used for price calcs (Normal, LogNormal, etc.)
OptSurface151priceTypeEnumEquity has independent sdiv and rate, Future has sdiv = rate
OptSurface154earnCntFloatnumber of qualifying earnings events prior to expiration [can be fractional] (from StockEarningsCalendar)
OptSurface157earnCntAdjFloatnumber of qualifying earnings events prior to expiration [adjusted] (from StockEarningsCalendar + LiveSurfaceTerm)
OptSurface160axisVolRTFloataxis volatility x sqrt(years) (used to compute xAxis) [usually 4m atm vol]
OptSurface163axisFUPrcFloataxis FwdUPrc (fwd underlying price used to compute xAxis)
OptSurface164synSpotDoubleSynthetic spot price (market-derived spot when the underlying is not a traded instrument)
OptSurface165synCarryDoubleSynthetic carry rate; corresponds to the relationship between uPrc and synSpot (set when the underlying is not a traded instrument)
OptSurface166atmStrikeFloatsynthetic strike with cPrice = pPrice
OptSurface169moneynessTypeEnummoneyness (xAxis) convention
OptSurface172underlierModeEnumunderlier pricing mode (None=use spot/stock market; FrontMonth=use front month future market * uPrcRatio; Actual = use actual underlier future market)
OptSurface175cpAdjTypeEnumadjustment used to align calls/puts (if any)
OptSurface178priceQuoteTypeEnumPrice or Vol
OptSurface181atmVolFloatatm vol (xAxis = 0)
OptSurface184atmCenFloatatm vol (xAxis = 0) (eMove/earnCntAdj censored)
OptSurface187atmVolHistFloathistorical realized volatility (includes eMoveHist x earnCntAdj adjustment). Note that this is the default atmVol if no implied markets existed previous day.
OptSurface190atmCenHistFloatcensored (earnings events removed) historical realized volatility. Trailing periods is 2x forward time to expiration. From HistoricalVolatility(windowType=hlCen).mv_nnn
OptSurface193eMoveFloatimplied earnings move (from LiveSurfaceTerm)
OptSurface196eMoveHistFloathistorical earnings move (avg of trailing 8 moves). From StockEarningsCalendar.eMoveHist
OptSurface199uPrcRatioDoubleuPrcAdj = uPrc * uPrcRatioFit
OptSurface202minAtmVolFloatminimum estimated atm vol
OptSurface205maxAtmVolFloatmaximum estimated atm vol
OptSurface208minCPAdjValDoubleminimum cpAdjVal (sdiv or uPrcRatio)
OptSurface211maxCPAdjValDoubleminimum cpAdjVal (sdiv or uPrcRatio)
OptSurface214atmFixedMoveFloatfixed strike atm move from prior period
OptSurface217atmPhiFloatsurface phi @ xAxis = 0
OptSurface220atmRhoFloatsurface rho @ xAxis = 0
OptSurface223atmVegaFloatsurface vega @ xAxis = 0
OptSurface226slopeFloatvolatility surface slope (dVol / dXAxis) @ ATM (xAxis=0)
OptSurface229varSwapFVFloatvariance swap fair value (estimated by numerical integration over OTM price surface)
OptSurface232gridTypeEnumgridType defines skew curve coeff points + spline type
OptSurface235knotShiftFloatconstant that should be added to each base knot location [-3.0 - +3.0]
OptSurface238fitPowerCFloatfit power of the vol fit (call wing)
OptSurface241fitPowerPFloatfit power of the vol fit (put wing)
OptSurface244minXAxisFloatminimum xAxis value; xAxis values to the left extrapolate horizontally
OptSurface247maxXAxisFloatmaximum xAxis value; xAxis values to the right extrapolate horizontally
OptSurface250asymptoticVolCFloatasymptotic volatility (call wing)
OptSurface253asymptoticVolPFloatasymptotic volatility (put wing)
OptSurface256minCurvValueFloatminimum curvature (2nd derivative) of skew curve (can be negative if curve is not strictly convex)
OptSurface259minCurvXAxisFloatxAxis of minimum curvature point
OptSurface262maxCurvValueFloatmaximum curvature (2nd derivative) of skew curve
OptSurface265maxCurvXAxisFloatxAxis of maximum curvature point
OptSurface268skewMinXFloatxAxis = (effStrike / effAxisFUPrc - 1.0) / axisVolRT; effStrike = strike * strikeRatio; effAxisFUPrc = axisFUPrc * symbolRatio
OptSurface271skewMinYFloatskewMinX / skewMinY are the skew curve minimum point (usually a positive x value and a negative y value)
OptSurface274surfaceFitEnum
OptSurface277skewC00Floatcurve coeff[0]
OptSurface280skewC01Floatcurve coeff[1]
OptSurface283skewC02Float
OptSurface286skewC03Float
OptSurface289skewC04Float
OptSurface292skewC05Float
OptSurface295skewC06Float
OptSurface298skewC07Float
OptSurface301skewC08Float
OptSurface304skewC09Float
OptSurface307skewC10Float
OptSurface310skewC11Float
OptSurface313skewC12Float
OptSurface316skewC13Float
OptSurface319skewC14Float
OptSurface322skewC15Float
OptSurface325skewC16Float
OptSurface328skewC17Float
OptSurface331skewC18Float
OptSurface334skewC19Float
OptSurface337skewC20Float
OptSurface340skewC21Float
OptSurface343skewC22Float
OptSurface346skewC23Float
OptSurface349skewC24Float
OptSurface352skewC25Float
OptSurface355skewC26Float
OptSurface358skewC27Float
OptSurface361skewC28Float
OptSurface364ivAdjD07FloatxAxis = -5.0
OptSurface367ivAdjD06FloatxAxis = -4.0
OptSurface370ivAdjD05FloatxAxis = -3.0
OptSurface373ivAdjD04FloatxAxis = -2.0
OptSurface376ivAdjD03FloatxAxis = -1.5
OptSurface379ivAdjD02FloatxAxis = -1.0
OptSurface382ivAdjD01FloatxAxis = -0.5
OptSurface385ivAdjU01FloatxAxis = +0.5
OptSurface388ivAdjU02FloatxAxis = +1.0
OptSurface391ivAdjU03FloatxAxis = +1.5
OptSurface394ivAdjU04FloatxAxis = +2.0
OptSurface397ivAdjU05FloatxAxis = +3.0
OptSurface400ivAdjU06FloatxAxis = +4.0
OptSurface403ivAdjU07FloatxAxis = +5.0
OptSurface406cpAdjD04FloatxAxis = -4.0
OptSurface409cpAdjD03FloatxAxis = -3.0
OptSurface412cpAdjD02FloatxAxis = -2.0
OptSurface415cpAdjD01FloatxAxis = -1.0
OptSurface418cpAdjU01FloatxAxis = +1.0
OptSurface421cpAdjU02FloatxAxis = +2.0
OptSurface424cpAdjU03FloatxAxis = +3.0
OptSurface427cpAdjU04FloatxAxis = +4.0
OptSurface430pwidthFloatminimum mkt premium width
OptSurface433vwidthFloatminimum mkt volatility width
OptSurface436cCntBytenum call strikes in base fit
OptSurface439pCntBytenum put strikes in base fit
OptSurface442cBidMissBytenumber of call bid violations (surface outside the market)
OptSurface445cAskMissBytenumber of call ask violations (surface outside the market)
OptSurface448pBidMissBytenumber of put bid violations
OptSurface451pAskMissBytenumber of put ask violations
OptSurface454fitAvgErrFloataverage error (sPrc - midPrc)
OptSurface457fitAvgAbsErrFloataverage absolute error (sPrc - midPrc)
OptSurface460fitMaxPrcErrFloatworst case surface premium violation
OptSurface463fitErrXXFloatokey_xx of the option with the largest fit error in this expiration
OptSurface466fitErrCPEnumokey_cp of the option with the largest fit error in this expiration
OptSurface469fitErrDeFloatdelta of fixErrXX
OptSurface472fitErrBidFloatbid of the option with the largest fit error
OptSurface475fitErrAskFloatask of the option with the largest fit error
OptSurface478fitErrPrcFloatsurface prc of the option with the largest fit error
OptSurface481fitErrVolFloatsurface vol of the option with the largest fit error
OptSurface484numSaddlePtsBytenumber of saddle points
OptSurface487minSaddleSpanFloatsmallest distance between saddle points
OptSurface490maxSaddleCurvatureFloatmaximum saddle point curvature
OptSurface493skewCounterIntskew surface fit counter
OptSurface496sdivCounterIntsdiv surface fit counter
OptSurface499marketSessionEnummarket session this surface is from
OptSurface502tradeableStatusEnumindicates whether the surface is currently tradeable or not (all server surface integrity checks pass)
OptSurface505surfaceResultEnum
OptSurface508sTimestampDateTimelast surface curve fit timestamp
OptSurface511timeTimeSpan
OptSurface514timestampDateTime
mTokenField NumberField NameField TypeField Description
OptSurface10ekeyExpiryKey
OptSurface11surfaceTypeEnum
OptSurface100tickerTickerKeyunderlying stock key that this option expiration attaches to
OptSurface103fkeyExpiryKeyunderlying future key (if any)
OptSurface106uPrcDriverKeyExpiryKeyunderlier driver key
OptSurface109uPrcDriverTypeEnumunderlier driver key type (stock or future)
OptSurface112uPrcDriverDoubleunderlier driver (mid-market)
OptSurface115uPrcDoubleeffective uPrc used for surface fitting
OptSurface118uBidDoubleeffective uBid
OptSurface121uAskDoubleeffective uAsk
OptSurface124yearsFloattime to expiration (in years)
OptSurface127rateFloataverage interest rate to expiration (SR global rate curve)
OptSurface130sdivFloatstock dividend (borrow rate)
OptSurface133ddivFloat(expected) cumulative discrete dividend $ amounts prior to expiration
OptSurface136ddivPvFloat(expected) cumulative npv of discrete dividend $ amounts prior to expiration (SR global rate curve)
OptSurface139ddivSourceEnumForecast if any of the dividends prior to expiry are forecast rather than announced
OptSurface142symbolRatioFloatunderlier price ratio (usually 1.0 or a multi-hedge option price ratio; if one exists)
OptSurface145exTypeEnumexercise type (American or European)
OptSurface148modelTypeEnumoption pricing model used for price calcs (Normal, LogNormal, etc.)
OptSurface151priceTypeEnumEquity has independent sdiv and rate, Future has sdiv = rate
OptSurface154earnCntFloatnumber of qualifying earnings events prior to expiration [can be fractional] (from StockEarningsCalendar)
OptSurface157earnCntAdjFloatnumber of qualifying earnings events prior to expiration [adjusted] (from StockEarningsCalendar + LiveSurfaceTerm)
OptSurface160axisVolRTFloataxis volatility x sqrt(years) (used to compute xAxis) [usually the minimum curve volatility]
OptSurface163axisFUPrcFloataxis FwdUPrc (fwd underlying price used to compute xAxis)
OptSurface166moneynessTypeEnummoneyness (xAxis) convention
OptSurface169priceQuoteTypeEnumPrice or Vol
OptSurface172atmVolFloatatm vol (xAxis = 0)
OptSurface175atmCenFloatatm vol (xAxis = 0) (eMove/earnCntAdj censored)
OptSurface178atmVolHistFloathistorical realized volatility (includes eMoveHist x earnCntAdj adjustment). Note that this is the default atmVol if no implied markets existed previous day.
OptSurface181atmCenHistFloatcensored (earnings events removed) historical realized volatility. Trailing periods is 2x forward time to expiration. From HistoricalVolatility(windowType=hlCen).mv_nnn
OptSurface184eMoveFloatimplied earnings move (from LiveSurfaceTerm)
OptSurface187eMoveHistFloathistorical earnings move (avg of trailing 8 moves). From StockEarningsCalendar.eMoveHist
OptSurface190uPrcRatioDoubleuPrcAdj = uPrc * uPrcRatioFit
OptSurface193minAtmVolFloatminimum estimated atm vol
OptSurface196maxAtmVolFloatmaximum estimated atm vol
OptSurface199minCPAdjValDoubleminimum cpAdjVal (sdiv or uPrcRatio)
OptSurface202maxCPAdjValDoubleminimum cpAdjVal (sdiv or uPrcRatio)
OptSurface205atmFixedMoveFloatfixed strike atm move from prior period
OptSurface208atmPhiFloatsurface phi @ xAxis = 0
OptSurface211atmRhoFloatsurface rho @ xAxis = 0
OptSurface214atmVegaFloatsurface vega @ xAxis = 0
OptSurface217slopeFloatvolatility surface slope (dVol / dXAxis) @ ATM (xAxis=0)
OptSurface220varSwapFVFloatvariance swap fair value (estimated by numerical integration over OTM price surface)
OptSurface223minXAxisFloatminimum xAxis value; left most point with a valid supporting strike
OptSurface226maxXAxisFloatmaximum xAxis value; right most point with a valid supporting strike
OptSurface229skewTickerTickerKeyreferences a SkewBasisCurve record
OptSurface232xShiftDouble
OptSurface235xMultDouble
OptSurface238skewMultDoubleSVOL = skewMult * BasisSkewFn(xShift + xMult * xAxis) + IVolBias(xAxis)
OptSurface241skewC00Floatcurve coeff[0]
OptSurface244skewC01Floatcurve coeff[1]
OptSurface247skewC02Float
OptSurface250skewC03Float
OptSurface253skewC04Float
OptSurface256skewC05Float
OptSurface259skewC06Float
OptSurface262skewC07Float
OptSurface265skewC08Float
OptSurface268skewC09Float
OptSurface271skewC10Float
OptSurface274skewC11Float
OptSurface277skewC12Float
OptSurface280skewC13Float
OptSurface283skewC14Float
OptSurface286skewC15Float
OptSurface289skewC16Float
OptSurface292skewC17Float
OptSurface295skewC18Float
OptSurface298skewC19Float
OptSurface301skewC20Float
OptSurface304skewC21Float
OptSurface307skewC22Float
OptSurface310skewC23Float
OptSurface313skewC24Float
OptSurface316skewC25Float
OptSurface319skewC26Float
OptSurface322skewC27Float
OptSurface325skewC28Float
OptSurface328skewC29Float
OptSurface331skewC30Float
OptSurface334cpAdjD04FloatxAxis = -4.0
OptSurface337cpAdjD03FloatxAxis = -3.0
OptSurface340cpAdjD02FloatxAxis = -2.0
OptSurface343cpAdjD01FloatxAxis = -1.0
OptSurface346cpAdjU01FloatxAxis = +1.0
OptSurface349cpAdjU02FloatxAxis = +2.0
OptSurface352cpAdjU03FloatxAxis = +3.0
OptSurface355cpAdjU04FloatxAxis = +4.0
OptSurface358pwidthFloatminimum mkt premium width
OptSurface361vwidthFloatminimum mkt volatility width
OptSurface364cCntBytenum call strikes in base fit
OptSurface367pCntBytenum put strikes in base fit
OptSurface370cBidMissBytenumber of call bid violations (surface outside the market)
OptSurface373cAskMissBytenumber of call ask violations (surface outside the market)
OptSurface376pBidMissBytenumber of put bid violations
OptSurface379pAskMissBytenumber of put ask violations
OptSurface382fitAvgErrFloataverage error (sPrc - midPrc)
OptSurface385fitAvgAbsErrFloataverage absolute error (sPrc - midPrc)
OptSurface388fitMaxPrcErrFloatworst case surface premium violation
OptSurface391fitErrXXFloatokey_xx of the option with the largest fit error in this expiration
OptSurface394fitErrCPEnumokey_cp of the option with the largest fit error in this expiration
OptSurface397fitErrDeFloatdelta of fixErrXX
OptSurface400fitErrBidFloatbid of the option with the largest fit error
OptSurface403fitErrAskFloatask of the option with the largest fit error
OptSurface406fitErrPrcFloatsurface prc of the option with the largest fit error
OptSurface409fitErrVolFloatsurface vol of the option with the largest fit error
OptSurface412numSaddlePtsBytenumber of saddle points
OptSurface415minSaddleSpanFloatsmallest distance between saddle points
OptSurface418maxSaddleCurvatureFloatmaximum saddle point curvature
OptSurface421marketSessionEnummarket session this surface is from
OptSurface424tradeableStatusEnumindicates whether the surface is currently tradeable or not (all server surface integrity checks pass)
OptSurface427surfaceResultEnum
OptSurface430timestampDateTime
mTokenField NumberField NameField TypeField Description
OptSurface10tickerTickerKey
OptSurface11daysShortdays to expiration [5, 21, 42, 63, 84, 105, 126, 189, 252, 378, 504]
OptSurface12surfaceTypeEnum
OptSurface100dateString
OptSurface103timeString
OptSurface106sDivFloatInterpolated implied sdiv rate (from LiveSurfaceFixedTerm.sDiv_N)
OptSurface109fwdUPrcFloatInterpolated implied forward price (from LiveSurfaceFixedTerm.fwdUPrc_N)
OptSurface112eCntIntNumber of expected earnings dates (from LiveSurfaceFixedTerm.eCnt_N)
OptSurface115eMoveFloatImplied earnings move (from LiveSurfaceFixedTerm.eMove)
OptSurface118eMoveHistFloatHistorical earnings move (from LiveSurfaceFixedTerm.eMoveHist)
OptSurface121volD45Floatxde = -45 (censored volatility)
OptSurface124volD40Floatxde = -40
OptSurface127volD35Floatxde = -35
OptSurface130volD30Floatxde = -30
OptSurface133volD25Floatxde = -25
OptSurface136volD20Floatxde = -20
OptSurface139volD15Floatxde = -15
OptSurface142volD10Floatxde = -10
OptSurface145volD05Floatxde = -5
OptSurface148volA00Floatxde = 0
OptSurface151volU05Floatxde = +5
OptSurface154volU10Floatxde = +10
OptSurface157volU15Floatxde = +15
OptSurface160volU20Floatxde = +20
OptSurface163volU25Floatxde = +25
OptSurface166volU30Floatxde = +30
OptSurface169volU35Floatxde = +35
OptSurface172volU40Floatxde = +40
OptSurface175volU45Floatxde = +45
OptSurface178vWidthFloatatm volatility width (from LiveSurfaceFixedTerm.vWidth_N)
OptSurface181vSlopeFloatatm volatility slope (from LiveSurfaceFixedTerm.vSlope_N)
OptSurface184loYearsFloatLiveSurfaceCurve.years before days [-1 = none]
OptSurface187hiYearsFloatLiveSurfaceCurve.years after days [-1 = none]
OptSurface190minDeltaFloatminimum valid strike delta
OptSurface193maxDeltaFloatmaximum valid strike delta
OptSurface196timestampDateTimesurface fit timestamp
mTokenField NumberField NameField TypeField Description
OptSurface10tickerTickerKey
OptSurface11surfaceTypeEnum
OptSurface50synSpotDoubleSynthetic spot price (market-derived spot when the underlying is not a traded instrument)
OptSurface100hEMoveFloatexpected forward earnings move (average of the last 8-12 underlier earnings moves; w/max clipping)
OptSurface103hEMoveNumBytenum historical earnings moves in historical window
OptSurface106hEMoveAvgFloatavg historical earnings move (last 8-12 underlier earnings moves)
OptSurface109hEMoveStdFloatstd historical earnings move (last 8-12 underlier earnings moves)
OptSurface112hEMoveMinFloatmax historical earnings move (last 8-12 underlier earnings moves)
OptSurface115hEMoveMaxFloatmin historical earnings move (last 8-12 underlier earnings moves)
OptSurface118iEMoveFloatimplied earnings move (implied move; all earnings events)
OptSurface121iEFitCodeEnumimplied EFit Code
OptSurface124iEFitErrorFloateMove fit error (term surface fit error)
OptSurface127expiryCountBytenumber of actual expirations involved
OptSurface130iEMoveAvgFloataverage eMove today
OptSurface133iEMoveStdFloateMove std dev today
OptSurface136iEMoveMinFloateMove min today
OptSurface139iEMoveMaxFloatemove max today
OptSurface142iEMoveCntIntnumber of surface term fits today
OptSurface145eMoveExpAdj1Intnumber of expirations (+/-) that the next earn date was moved to best fit market term structure (if any)
OptSurface148eMoveYrsAdj1Floatnumber of trading years (+/-) that the next earn date was moved to best fit market term structure (if any)
OptSurface151eMoveYears1Floatyears to expiration from LiveSurfaceCurve.pkey.ekey = eMoveFKey1
OptSurface154eMoveEKey1ExpiryKeyLiveSurfaceCurve.pkey.ekey immediately after 1st implied earnings move (note: this will not match the base earnings calendar if eMoveDtAdj1 != 0)
OptSurface157eMoveExpAdj2Intnumber of expirations (+/-) that the 2nd earn date was moved to best fit market term structure (if any)
OptSurface160eMoveYrsAdj2Floatnumber of trading years (+/-) that the 2nd earn date was moved to best fit market term structure (if any)
OptSurface163eMoveYears2Floatyears to expiration from LiveSurfaceCurve.pkey.fkey = eMoveFKey2
OptSurface166eMoveEKey2ExpiryKeyLiveSurfaceCurve.pkey.ekey immediately after 2nd implied earnings move (note: this will not match the base earnings calendar if eMoveDtAdj2 != 0)
OptSurface169atmCenI_stFloatshort term (5 day) model atm volatility (censored using iEMult)
OptSurface172atmCenI_ltFloatlong term (504 day) model atm volatility
OptSurface175atmCenI_decayFloatmodel decay parameter
OptSurface178atmCenI_5dFloatInterpolated 5 day atm vol (censored using iEMult)
OptSurface181atmCenI_10dFloatInterpolated 10 day atm vol
OptSurface184atmCenI_21dFloatInterpolated 21 day atm vol
OptSurface187atmCenI_42dFloatInterpolated 42 day atm vol
OptSurface190atmCenI_63dFloatInterpolated 63 day atm vol
OptSurface193atmCenI_84dFloatInterpolated 84 day atm vol
OptSurface196atmCenI_105dFloatInterpolated 105 day atm vol
OptSurface199atmCenI_126dFloatInterpolated 126 day atm vol
OptSurface202atmCenI_189dFloatInterpolated 189 day atm vol
OptSurface205atmCenI_252dFloatInterpolated 252 day atm vol
OptSurface208atmCenI_378dFloatInterpolated 378 day atm vol
OptSurface211atmCenI_504dFloatInterpolated 504 day atm vol
OptSurface214atmCenH_stFloatshort term (5 day) model atm volatility (censored using hEMult)
OptSurface217atmCenH_ltFloatlong term (504 day) model atm volatility
OptSurface220atmCenH_decayFloatmodel decay parameter
OptSurface223atmCenH_5dFloatInterpolated 5 day atm vol (censored using hEMult)
OptSurface226atmCenH_10dFloatInterpolated 10 day atm vol
OptSurface229atmCenH_21dFloatInterpolated 21 day atm vol
OptSurface232atmCenH_42dFloatInterpolated 42 day atm vol
OptSurface235atmCenH_63dFloatInterpolated 63 day atm vol
OptSurface238atmCenH_84dFloatInterpolated 84 day atm vol
OptSurface241atmCenH_105dFloatInterpolated 105 day atm vol
OptSurface244atmCenH_126dFloatInterpolated 126 day atm vol
OptSurface247atmCenH_189dFloatInterpolated 189 day atm vol
OptSurface250atmCenH_252dFloatInterpolated 252 day atm vol
OptSurface253atmCenH_378dFloatInterpolated 378 day atm vol
OptSurface256atmCenH_504dFloatInterpolated 504 day atm vol
OptSurface259sDiv_5dFloatInterpolated 5 day implied sdiv rate
OptSurface262sDiv_10dFloatInterpolated 10 day implied sdiv rate
OptSurface265sDiv_21dFloatInterpolated 21 day implied sdiv rate
OptSurface268sDiv_42dFloatInterpolated 42 day implied sdiv rate
OptSurface271sDiv_63dFloatInterpolated 63 day implied sdiv rate
OptSurface274sDiv_84dFloatInterpolated 84 day implied sdiv rate
OptSurface277sDiv_105dFloatInterpolated 105 day implied sdiv rate
OptSurface280sDiv_126dFloatInterpolated 126 day implied sdiv rate
OptSurface283sDiv_189dFloatInterpolated 189 day implied sdiv rate
OptSurface286sDiv_252dFloatInterpolated 252 day implied sdiv rate
OptSurface289sDiv_378dFloatInterpolated 378 day implied sdiv rate
OptSurface292sDiv_504dFloatInterpolated 504 day implied sdiv rate
OptSurface295fwdUPrc_5dFloatInterpolated 5 day implied forward price
OptSurface298fwdUPrc_10dFloatInterpolated 10 day implied forward price
OptSurface301fwdUPrc_21dFloatInterpolated 21 day implied forward price
OptSurface304fwdUPrc_42dFloatInterpolated 42 day implied forward price
OptSurface307fwdUPrc_63dFloatInterpolated 63 day implied forward price
OptSurface310fwdUPrc_84dFloatInterpolated 84 day implied forward price
OptSurface313fwdUPrc_105dFloatInterpolated 105 day implied forward price
OptSurface316fwdUPrc_126dFloatInterpolated 126 day implied forward price
OptSurface319fwdUPrc_189dFloatInterpolated 189 day implied forward price
OptSurface322fwdUPrc_252dFloatInterpolated 252 day implied forward price
OptSurface325fwdUPrc_378dFloatInterpolated 378 day implied forward price
OptSurface328fwdUPrc_504dFloatInterpolated 504 day implied forward price
OptSurface331vWidth_5dFloatInterpolated 5 day market vwidth
OptSurface334vWidth_10dFloatInterpolated 10 day market vwidth
OptSurface337vWidth_21dFloatInterpolated 21 day market vwidth
OptSurface340vWidth_42dFloatInterpolated 42 day market vwidth
OptSurface343vWidth_63dFloatInterpolated 63 day market vwidth
OptSurface346vWidth_84dFloatInterpolated 84 day market vwidth
OptSurface349vWidth_105dFloatInterpolated 105 day market vwidth
OptSurface352vWidth_126dFloatInterpolated 126 day market vwidth
OptSurface355vWidth_189dFloatInterpolated 189 day market vwidth
OptSurface358vWidth_252dFloatInterpolated 252 day market vwidth
OptSurface361vWidth_378dFloatInterpolated 378 day market vwidth
OptSurface364vWidth_504dFloatInterpolated 504 day market vwidth
OptSurface367vSlope_5dFloatInterpolated 5 day atm vol slope
OptSurface370vSlope_10dFloatInterpolated 10 day atm vol slope
OptSurface373vSlope_21dFloatInterpolated 21 day atm vol slope
OptSurface376vSlope_42dFloatInterpolated 42 day atm vol slope
OptSurface379vSlope_63dFloatInterpolated 63 day atm vol slope
OptSurface382vSlope_84dFloatInterpolated 84 day atm vol slope
OptSurface385vSlope_105dFloatInterpolated 105 day atm vol slope
OptSurface388vSlope_126dFloatInterpolated 126 day atm vol slope
OptSurface391vSlope_189dFloatInterpolated 189 day atm vol slope
OptSurface394vSlope_252dFloatInterpolated 252 day atm vol slope
OptSurface397vSlope_378dFloatInterpolated 378 day atm vol slope
OptSurface400vSlope_504dFloatInterpolated 504 day atm vol slope
OptSurface403eCnt_5dBytenumber of expected earnings events
OptSurface406eCnt_10dBytenumber of expected earnings events
OptSurface409eCnt_21dBytenumber of expected earnings events
OptSurface412eCnt_42dBytenumber of expected earnings events
OptSurface415eCnt_63dBytenumber of expected earnings events
OptSurface418eCnt_84dBytenumber of expected earnings events
OptSurface421eCnt_105dBytenumber of expected earnings events
OptSurface424eCnt_126dBytenumber of expected earnings events
OptSurface427eCnt_189dBytenumber of expected earnings events
OptSurface430eCnt_252dBytenumber of expected earnings events
OptSurface433eCnt_378dBytenumber of expected earnings events
OptSurface436eCnt_504dBytenumber of expected earnings events
OptSurface439statusEnum
OptSurface442timeTimeSpan
OptSurface445timestampDateTimeupdate timestamp
mTokenField NumberField NameField TypeField Description
MLinkWs100stateEnum
MLinkWs103detailText1
mTokenField NumberField NameField TypeField Description
MLinkRest100countLong
mTokenField NumberField NameField TypeField Description
MLinkWs100msgTypeUShortmessage type of the data object being ack’d
MLinkWs103sendTsLongsend timestamp of the data object being ack’d (note: MessageType + SendTimestamp should be unique)
MLinkWs106resultEnum
MLinkWs109detailText1
mTokenField NumberField NameField TypeField Description
MLinkWs100seqNumInt
MLinkWs103timestampDateTime
mTokenField NumberField NameField TypeField Description
MLinkWs100userNameText1SR UserName
MLinkWs103passwordText1client supplied secret (optional; required if supplied previously)
MLinkWs106pinStringSR Mfa Pin
MLinkWs109apiKeyStringSR generated API key
MLinkWs112jwtTokenText1Cognito JWT token
mTokenField NumberField NameField TypeField Description
MLinkWs100sessionIDShort(optional) subscription sessionID (if missing or -1 will signal all sessionIDs for this websocket connection)
MLinkWs103signalIDLong(optional) will be reflected back in xCheckPt.signalID fields that indicates that a specified signal ready triggered active send is complete.
MLinkWs106readyScanEnum(optional; default is Incremental) Incremental = messages w/changes (all fields; cumulative changes) since previous MLinkSignalReady; FullScan = all messages
mTokenField NumberField NameField TypeField Description
MLinkWs100msgNameString(required) a SpiderRock message name (topic channel) (can be string name or protobuf message number)
MLinkWs103whereText2(optional) where clause; eg. “(bidexch:eq:AMEXbidexch:eq:CBOE) & bidsize:ge:100” (default is all records)
MLinkWs106viewText2(optional) list (subset) of field names to return with this message (eg. bidprice,askprice,bidsize,asksize) (default is all names)
MLinkWs109unsubscribeEnum(optional) if set to Yes the specified message type will be unsubscribed and thus no longer return
MLinkWs112sessionIDShort(optional) actions below apply only to the sessionID virtual session; should be zero for non-multiplexed web-socket connections.
MLinkWs115queryIDLong(optional) queryID will be reflected back in the corresponding MLinkStreamAck message; nothing is assumed about structure of this number
MLinkWs118queryLabelString(optional) query label; used for logging and query tracking
MLinkWs121activeLatencyInt(optional) number of milliseconds between active send attempts (1 = minimum delay, 0 = wait for SignalReady) [default = 0]
MLinkWs124sysEnvironmentEnum(optional) records cannot have [sysEnvironment + sysRealm] in their route history (no loops)
MLinkWs127sysRealmEnum
MLinkWs130highwaterTsLong(optional) records must have a header.sentTs that is later than this value (nanoseconds after the UNIX epoch) [-1 means start from current server side highwaterTs]
MLinkWs133stripeFilterText1(optional) if supplied records must be within the specified stripe
MLinkWs136schemaHashLong(optional) message schema hash [if supplied and matches server schema hash for this message binary encoding will be used]
MLinkWs139localMsgTypeUShort(optional) if != 0 the msgType number will be translated from msgType to localMsgType in the mlink server (protobuf and binary messages)
MLinkWs142localMsgNameString(optional) if exists the message name will be translated from msgName to localMsgName in the mlink server (json messages)
mTokenField NumberField NameField TypeField Description
MLinkWs100sessionIDShortfrom MLinkStream.sessionID
MLinkWs103queryIDLongfrom MLinkStream.queryID
MLinkWs106querySendTsLongMLinkStream.header.sentTs (should be unique)
MLinkWs109queryLabelStringfrom MLinkStream.queryLabel
MLinkWs112unsubscribeEnumfrom MLinkStream.unsubscribe
MLinkWs115msgNameString(required) a SpiderRock message name (topic channel) (can be string name or protobuf message number)
MLinkWs118resultEnum
MLinkWs121detailString
mTokenField NumberField NameField TypeField Description
MLinkWs100sessionIDShortfrom MLinkStream.sessionID
MLinkWs103queryIDLongfrom MLinkStream.queryID
MLinkWs106signalIDLongfrom MLinkSignalReady.signalID (if send sequence triggered by an MLinkSignalReady message)
MLinkWs109stateEnum
MLinkWs112detailText1
MLinkWs115highwaterTsLong
MLinkWs118numBytesSentLong
MLinkWs121numMessagesSentInt
MLinkWs124waitElapsedDoublewait time between active send operations (SRC or timer)
MLinkWs127queryElapsedDoubletotal time spent in active send loop
MLinkWs130tryFwdElapsedDoubletotal time spent scan/skipping
MLinkWs133sendElapsedDoubletotal time spend encoding/copying to send buffer
MLinkWs136flushElapsedDoubletotal time spend sending/blocking on web socket
MLinkWs139timestampDateTime
mTokenField NumberField NameField TypeField Description
MLinkWs100sessionIDShort(optional) actions below apply only to the sessionID virtual channel; should be zero for non-multiplexed web-socket connections.
MLinkWs103subscribeIDLong(optional) subscribeD will be reflected back in the corresponding MLinkSubscribeAck message; nothing is assumed about structure of this number
MLinkWs106activeLatencyInt(optional) number of milliseconds between active send attempts (1 = minimum delay, 0 = wait for SignalReady) [default = 0]
MLinkWs109compressionEnum(optional) FieldChangesOnly will supress fields in messages that have not changed since the previous send (resets automatically after every subscription)
MLinkWs112doResetEnumif Yes all current subscriptions will be removed prior to applying the actions below
MLinkWs133SubscribeRepeater
MLinkWs136msgNameString(required) a SpiderRock message name (topic channel) (can be string name or protobuf message number)
MLinkWs139msgPKeyString(required) must be an existing message.pkey; can be in either flat string or JSON format
MLinkWs124UnsubscribeRepeater
MLinkWs127msgNameString(required) a SpiderRock message name (topic channel) (can be string name or protobuf message number)
MLinkWs130msgPKeyString# an existing message.pkey; can be in either flat string or JSON format; if missing/empty all active msgName subscriptions will be removed
MLinkWs115ViewRepeater
MLinkWs118msgNameStringa SpiderRock message name (topic channel) (can be string name or protobuf message number)
MLinkWs121viewStringlist (subset) of field names to return with this message type (eg. bidprice,askprice,bidsize,asksize)
mTokenField NumberField NameField TypeField Description
MLinkWs100sessionIDShortfrom MLinkSubscribe.sessionID
MLinkWs103subscribeIDLongfrom MLinkSubscribe.subscribeID
MLinkWs106numActiveSubscriptionsInt
MLinkWs109didResetEnumif Yes all current subscriptions were removed prior to applying the actions below
MLinkWs139SubscribeRepeater
MLinkWs142msgNameString(required) a SpiderRock message name (topic channel)
MLinkWs145msgPKeyString(required) must be an existing message.pkey; can be in either flat string or JSON format
MLinkWs148resultEnum
MLinkWs151detailString
MLinkWs127UnsubscribeRepeater
MLinkWs130msgNameString(required) a SpiderRock message name (topic channel)
MLinkWs133msgPKeyStringan existing message.pkey; can be in either flat string or JSON format; if missing/empty all active msgName subscriptions will be removed
MLinkWs136resultEnum
MLinkWs112ViewRepeater
MLinkWs115msgNameStringa SpiderRock message name (topic channel) (can be string name or protobuf message number)
MLinkWs118viewStringlist (subset) of field names to return with this message type (eg. bidprice,askprice,bidsize,asksize)
MLinkWs121resultEnum
MLinkWs124detailString
mTokenField NumberField NameField TypeField Description
MLinkWs100sessionIDShortfrom MLinkSubscribe.sessionID
MLinkWs103subscribeIDLongfrom MLinkSubscribe.subscribeID
MLinkWs106signalIDLongMLinkSignalReady.signalID (if send sequence triggered by an MLinkSignalReady message)
MLinkWs109stateEnum
MLinkWs112detailText1
mTokenField NumberField NameField TypeField Description
MLinkRest100nameStringmessage name
MLinkRest103mNumUShortprotobuf message number
MLinkRest106schemaHashStringschema hash (changes each time the schema is modified)
MLinkRest109actionsString’SIURD’
MLinkRest112hasTKeyEnummessage contains a ‘TickerKey’ x-ray field
MLinkRest115hasEKeyEnummessage contains an ‘ExpiryKey’ x-ray field
MLinkRest118hasOKeyEnummessage contains an ‘OptionKey’ x-ray field
MLinkRest121hasCFEnummessage has a ‘ClientFirm’ fields (message has client firm visiblity restrictions)
MLinkRest124mTokenEnumthe mlink token this message is associated with
MLinkRest127descText2message description (if any)
MLinkRest130priTimeFieldStringthis is the primary time field for the time control and histogram
MLinkRest133secTimeFieldStringthis is the Top10 field for the stacked bar / label on the time control histogram (blank if none)
MLinkRest136defaultGridFieldsText2comma separated list of (default) visible grid fields (in grid order)
MLinkRest139staticFilterFieldsText2comma separated list of (default) static filter fields (in display order)
mTokenField NumberField NameField TypeField Description
MLinkRest100expiryKeyExpiryKey
mTokenField NumberField NameField TypeField Description
MLinkRest100optionKeyOptionKey
mTokenField NumberField NameField TypeField Description
MLinkRest100tickerKeyTickerKey
mTokenField NumberField NameField TypeField Description
OptionDefinition10opraPrintTypeByte
OptionDefinition100printTypeCharStringcharacter value of printType
OptionDefinition103printCodeStringeg, AUTO, CANC
OptionDefinition106printCodeStringText1longer string
OptionDefinition109printCodeDescriptionText1full description
mTokenField NumberField NameField TypeField Description
OptionDefinition10ekeyExpiryKeyoption root+expiration
OptionDefinition100tickerTickerKeymaster ticker
OptionDefinition103fkeyExpiryKeysettlement future (if any)
OptionDefinition106uPrcDriverKeyExpiryKeyunderlier price driver for this option expiry (default is fkey; if it exists)
OptionDefinition109uPrcDriverKeyTypeEnumStock or Future
OptionDefinition112uPrcBoundFKeyExpiryKeyunderlier price bounding future (if any) for this option expiry
OptionDefinition115expirationDateTimeoption expiration date and time
OptionDefinition118maturityDateDateTime
OptionDefinition121displayFactorDouble
OptionDefinition124cabPriceDouble
OptionDefinition127priceFormatEnum
OptionDefinition130minTickSizeDouble
OptionDefinition133timestampDateTime
mTokenField NumberField NameField TypeField Description
OptSurface10ekeyExpiryKey
OptSurface11tradingDateDateTime
OptSurface12minuteIntminutes since 2000-01-01
OptSurface100tickerTickerKey
OptSurface103startTimeDateTimeStart of trading period for this product (note: this field will only be populated in the first message sent)
OptSurface106startTimeMinuteStringMinute representation of startTime (note: this field will only be populated in the first message sent)
OptSurface109endTimeDateTimeEnd of trading period for this product (note: this field will only be populated in the first message sent)
OptSurface112endTimeMinuteStringMinute representation of endTime (note: this field will only be populated in the first message sent)
OptSurface115uPrcDoubleUnderlying price
OptSurface118yearsFloatYears to expiry
OptSurface121rateFloatInterest rate
OptSurface124sdivFloatContinuous stock dividend
OptSurface127ddivFloatDiscrete stock dividend value
OptSurface130uPrcRatioDoubleImplied underlying price offset. For options with futures underlyings, this is like sDiv for futures.
OptSurface133ivolFloatatm ivol (atm: strike = fUPrc)
OptSurface136ivxxFloatfixed strike ivol (ivol @ refStrike)
OptSurface139ivCenFloatatm ivol (atm: strike = fUPrc) [eMove/earnings censored]
OptSurface142slopeFloatdVol / dXAxis
OptSurface145vWidthFloatimplied volatility width (best market)
OptSurface148refStrikeFloatreference strike (usually prior day closing uPrc)
OptSurface151ivolHiFloatImplied Volatility high value (during bar)
OptSurface154ivolLoFloatImplied Volatility low value (during bar)
OptSurface157ivxxHiFloatImplied Volatility of Previous Day’s ATM strike, high value (during bar)
OptSurface160ivxxLoFloatImplied Volatility of Previous Day’s ATM strike, low value (during bar)
OptSurface163ivCenHiFloatCensored implied volatility high value (during bar)
OptSurface166ivCenLoFloatCensored implied volatility low value (during bar)
OptSurface169sdivHiFloatContinuous carry rate, high value (during bar)
OptSurface172sdivLoFloatContinuous carry rate, low value (during bar)
OptSurface175uPrcRatioHiDoubleUnderlying price offset value, high value (during bar)
OptSurface178uPrcRatioLoDoubleUnderlying price offset value, low value (during bar)
OptSurface181slopeHiFloatSlope high value (during bar). The difference between the put and call at 1/2 standard deviation from the ATM point.
OptSurface184slopeLoFloatSlope low value (during bar). The difference between the put and call at 1/2 standard deviation from the ATM point.
OptSurface187varSwapFVFloatvariance swap fair value (estimated by numerical integration over OTM price surface)
OptSurface190maxDIVolFloatmaximum change in IVol (between LSA rec publishes)
OptSurface193maxDSDivFloatmaximum change is SDiv (between LSA rec publishes)
OptSurface196uPrcSPYDoubleSPY underlying price
OptSurface199ivolSPYFloatSPY atm ivol
OptSurface202ivxxSPYFloatSPY fixed strike ivol
OptSurface205marketSegmentEnum
OptSurface208tsDateTimelast update time (Date)
mTokenField NumberField NameField TypeField Description
OptMarkData10okeyOptionKey
OptMarkData100tradeDateDateKey
OptMarkData103clsMarkStateEnumLastPrt = last print received; SRClose = SpiderRock snapshot; ExchClose = official exchange close price; Final = Final close mark
OptMarkData106uBidDoubleSpiderRock closing underlier bid (C - 1m)
OptMarkData109uAskDoubleSpiderRock closing underlier ask (C - 1m)
OptMarkData112uSrClsDoubleSpiderRock underlier closing mark (C - 1m)
OptMarkData115uCloseDoubleexchange underlier closing mark
OptMarkData118bidPrcFloatSpiderRock closing option bid (C - 1m)
OptMarkData121askPrcFloatSpiderRock closing option ask (C - 1m)
OptMarkData124srClsPrcDoubleSpiderRock close mark (close - 1min)
OptMarkData127closePrcDoubleofficial exchange closing mark (last print;then official close)
OptMarkData130hasSRClsPrcEnum
OptMarkData133hasClosePrcEnum
OptMarkData136bidIVFloatimplied vol of SpiderRock closing bid price (C - 1m)
OptMarkData139askIVFloatimplied vol of SpiderRock closing ask price (C - 1m)
OptMarkData142srPrcFloatSpiderRock surface price (always within bidPx/askPx) (C - 1m)
OptMarkData145srVolFloatSpiderRock surface volatility (C - 1m)
OptMarkData148srSrcEnumSpiderRock price source [NbboMid, SRVol, LoBound, HiBound, SRPricer, SRQuote, CloseMark]
OptMarkData151deFloatdelta (SR surface)
OptMarkData154gaFloatgamma (SR surface)
OptMarkData157thFloattheta (SR surface)
OptMarkData160veFloatvega (SR surface)
OptMarkData163voFloatvolga (SR surface)
OptMarkData166vaFloatvanna (SR surface)
OptMarkData169rhFloatrho (SR surrface)
OptMarkData172phFloatphi (SR surface)
OptMarkData175srSlopeFloatsurface slope (SR surface)
OptMarkData178deDecayFloatdelta decay (SR surface)
OptMarkData181sdivFloatSpiderRock sdiv rate
OptMarkData184ddivFloatSpiderRock ddiv rate (sum of discrete dividend amounts)
OptMarkData187rateFloatSpiderRock interest rate
OptMarkData190yearsFloatyears to expiration
OptMarkData193errorByteSpiderRock pricing library calculation error code
OptMarkData196openInterestIntOpen Interest
OptMarkData199prtCountIntprint count
OptMarkData202prtVolumeInttotal printed volume
OptMarkData205srCloseMarkDttmDateTimefrom MarketCloseQuote.srCloseMarkDttm
OptMarkData208timestampDateTimerecord timestamp
mTokenField NumberField NameField TypeField Description
OptMktData10sequenceNumberIntsequence of the flex event message counting from the start of day or last restart of the feed handler
OptMktData100eventIdIntunique id of the event assigned by SpiderRock, subsequent messages on the event will use the same id
OptMktData103prtExchEnumexchange code that produced this flex event
OptMktData106prtRootStringsecurity symbol of the FLEX option
OptMktData109requestIdIntrequest identifier associated with this trade assigned by the exchange (these appear to not be 100% reliable, particularly for PHLX)
OptMktData112eventTypeEnumtype of event this message represents, e.g., RFQ, QTE, LST
OptMktData115totalQuantityInttotal quantity of the flex trade
OptMktData118packagePriceDoubletotal price of the flex trade inclusive of all legs
OptMktData121netTimestampLongtimestamp of when this message was received
OptMktData124srcTimestampLongtimestamp from the exchange of when this message was sent
OptMktData127LegsRepeater
OptMktData130okeyOptionKeyOptionKey of the instrument, if available
OptMktData133flexTypeEnumEuropean or American exercise, AM or PM exercise time
OptMktData136quantityIntquantity of contracts in this leg of the event
OptMktData139priceDoubleprice of this leg of the event, could be quoted in percentage of closing price
OptMktData142priceTypeEnumprice type of the event
OptMktData145deltaDoubledelta supplied with the event for delta adjusted at close events
OptMktData148refPriceDoublereference price of the event, for use in delta ajusting the final price
OptMktData151closePriceDoubleclose price used for both percentage adjusted and delta adjusted events
OptMktData154priceAdjDoublefinal adjusted price, made available after the event is marked as PctAdjApplied or DeltaAdjApplied
OptMktData157strikeAdjDoublefinal adjusted strike, made available after the event is marked PctAdjApplied
OptMktData160bidPriceDoublebid price from QTE messages
OptMktData163bidSizeDoublebid size from QTE messages
OptMktData166askPriceDoubleask price from QTE messages
OptMktData169askSizeDoubleask size from QTE messages
OptMktData172rawTextStringraw text of the flex event
mTokenField NumberField NameField TypeField Description
OptSummaryData10okeyOptionKey
OptSummaryData100opnPriceDoublestart of day (SR) open mark
OptSummaryData103opnVolatilityDoublestart of day (SR) open mark (volatility)
OptSummaryData106clsPriceDoubleend of day (SR) close mark
OptSummaryData109clsVolatilityDoubleend of day (SR) close mark (volatility)
OptSummaryData112minPrtPrcDoubleminimum print price within market hours
OptSummaryData115minPrtVolDoubleminimum print volatility within market hours
OptSummaryData118maxPrtPrcDoublemaximum print price within market hours
OptSummaryData121maxPrtVolDoublemaximum print volatility within market hours
OptSummaryData124openInterestInt
OptSummaryData127bidCountIntnum prints less than or equals to SR surface mark
OptSummaryData130bidVolumeIntvolume when prtPrice less than or equals to quote.bid
OptSummaryData133askCountIntnum prints greater than or equals to SR surface mark
OptSummaryData136askVolumeIntvolume when prtPrice greater than or equals to quote.ask
OptSummaryData139midCountIntnum prints inside quote.ebid / quote.eask
OptSummaryData142midVolumeIntvolume inside quote.ebid / quote.eask
OptSummaryData145prtCountIntnumber of distinct print reports
OptSummaryData148lastPrtPriceDoublelast print price
OptSummaryData151lastPrtVolatilityFloatlast print volatility
OptSummaryData154avgWidthDoubleaverage market width (time weighted)
OptSummaryData157avgBidSizeFloataverage bid size (time weighted)
OptSummaryData160avgAskSizeFloataverage ask size (time weighted)
OptSummaryData163lastPrintDateTime
OptSummaryData166timestampDateTime
mTokenField NumberField NameField TypeField Description
OptMktData10okeyOptionKey
OptMktData100updateTypeEnum
OptMktData103bidPriceFloatbid price
OptMktData106askPriceFloatask price
OptMktData109bidSizeIntbid size in contracts (largest exch quote)
OptMktData112askSizeIntask size in contracts (largest exch quote)
OptMktData115cumBidSizeIntbid size in contracts (total nbbo size)
OptMktData118cumAskSizeIntask size in contracts (total nbbo size)
OptMktData121bidExchEnumfirst (or largest remaining) exchange at bid price
OptMktData124askExchEnumfirst (or largest remaining) exchange at ask price
OptMktData127bidMaskUIntexchange bid bit mask
OptMktData130askMaskUIntexchange ask bit mask
OptMktData133bidMktTypeFlagbid side quote flags (if any)
OptMktData136askMktTypeFlagask side quote flags (if any)
OptMktData139bidPrice2Float2nd best bid price
OptMktData142askPrice2Float2nd best ask price
OptMktData145cumBidSize2Intcumulative size at 2nd price
OptMktData148cumAskSize2Intcumulative size at 2nd price
OptMktData151bidTimeIntlast bid price change (milliseconds since midnight) calculated from the srcTimestamp
OptMktData154askTimeIntlast ask price change (milliseconds since midnight) calculated from the srcTimestamp
OptMktData157srcTimestampLongsource high precision timestamp (if available)
OptMktData160netTimestampLonginbound packet PTP timestamp from SR gateway switch;usually syncronized with facility grandfather clock
mTokenField NumberField NameField TypeField Description
OptMarkData10okeyOptionKey
OptMarkData100openIntInt
OptMarkData103timestampDateTime
mTokenField NumberField NameField TypeField Description
OptMarkData10okeyOptionKey
OptMarkData100tradeDateDateKey
OptMarkData103uBidDoubleSR open uBid; (SR close uBid overnight adjusted)
OptMarkData106uAskDoubleSR open uAsk; (SR close uAsk overnight adjusted)
OptMarkData109uSrClsDoubleSR open uMark; [SR close uMark (C - 1m) overnight adjusted]
OptMarkData112uCloseDoubleexchange open uMark; [exchange close uMark overnight adjusted]
OptMarkData115bidPrcFloatSR open bid; [SR close bid overnight adjusted]
OptMarkData118askPrcFloatSR open ask; [SR close ask overnight adjusted]
OptMarkData121srClsPrcDoubleSR open mark; [SR close mark (close - 1min) overnight adjusted]
OptMarkData124closePrcDoubleexchange open mark; [exchange close mark overnight adjusted] [if available]
OptMarkData127bidIVFloatimplied vol of SR closing bid price
OptMarkData130askIVFloatimplied vol of SR closing ask price
OptMarkData133srPrcFloatSR open surface price; [SR close surface price overnight adjusted]
OptMarkData136srVolFloatSR surface volatility
OptMarkData139srSrcEnum
OptMarkData142deFloatgreeks from SR surface volatility
OptMarkData145gaFloat
OptMarkData148thFloat
OptMarkData151veFloat
OptMarkData154voFloatvolga (SR surface)
OptMarkData157vaFloatvanna (SR surface)
OptMarkData160rhFloat
OptMarkData163phFloat
OptMarkData166srSlopeFloatsurface slope (SR surface)
OptMarkData169deDecayFloat
OptMarkData172sdivFloatSR live sdiv rate
OptMarkData175ddivFloatSR live ddiv rate
OptMarkData178rateFloatSR live int rate
OptMarkData181yearsFloatyears to expiration
OptMarkData184errorByteSRPricingLib.CalcError
OptMarkData187corpActionText1
OptMarkData190timestampDateTime
mTokenField NumberField NameField TypeField Description
OptMktData10okeyOptionKey
OptMktData100prtExchEnum
OptMktData103prtSizeIntprint size [contracts]
OptMktData106prtPriceFloatprint price
OptMktData109prtClusterNumIntincremental print cluster counter (one counter per okey; used to group prints into clusters)
OptMktData112prtClusterSizeIntcumulative size of prints in this sequence (sequence of prints @ same or more aggressive price with less than 25 ms elapsing since first print; can span exchanges)
OptMktData115prtTypeEnumprint type
OptMktData118prtOrdersUShortnumber of participating orders
OptMktData121prtVolumeIntday print volume in contracts [this exchange]
OptMktData124cxlVolumeIntday print/cancel volume (num of contracts printed and then cancelled)
OptMktData127bidCountUShortnumber of bid prints
OptMktData130askCountUShortnumber of ask prints
OptMktData133bidVolumeIntbid print volume in contracts
OptMktData136askVolumeIntask print volume in contracts
OptMktData139ebidFloatexchange bid (@ print time)
OptMktData142easkFloatexchange ask (@ print time)
OptMktData145ebszIntexchange bid size
OptMktData148easzIntexchange ask size
OptMktData151eageFloatage of prevailing quote at time of print
OptMktData154bidPriceFloatnbbo bid price (@ print time)
OptMktData157askPriceFloatnbbo ask price (@ print time)
OptMktData160bidPrice2Float2nd best bid price (@ print time)
OptMktData163askPrice2Float2nd best ask price (@ print time)
OptMktData166bidSizeIntbid size in contracts (largest exch quote)
OptMktData169askSizeIntask size in contracts (largest exch quote)
OptMktData172cumBidSizeIntbid size in contracts (total nbbo size)
OptMktData175cumAskSizeIntask size in contracts (total nbbo size)
OptMktData178cumBidSize2Intcumulative size at 2nd price
OptMktData181cumAskSize2Intcumulative size at 2nd price
OptMktData184bidMaskUIntexchange bid bit mask
OptMktData187askMaskUIntexchange ask bit mask
OptMktData190prtSideEnumimplied print side (based on ebid/eask and nbbo market)
OptMktData193prtTimestampLongexchange high precision timestamp (if available)
OptMktData196netTimestampLonginbound packet PTP timestamp from SR gateway switch;usually syncronized with facility grandfather clock
OptMktData199oqNetTimestampLonginbound packet PTP timestamp from SR gateway switch;usually syncronized with facility grandfather clock
OptMktData202timestampDateTime
mTokenField NumberField NameField TypeField Description
OptProbModel10okeyOptionKey
OptProbModel11stateModelEnum
OptProbModel100prtPriceFloat
OptProbModel103prtSizeInt
OptProbModel106prtProbFloatprobability that this print will result in positive PnL
OptProbModel109prtSideEnum
OptProbModel112bidPriceFloatnbbo bid price
OptProbModel115askPriceFloatnbbo ask price
OptProbModel118bidSizeIntcumulative size @ bid price
OptProbModel121askSizeIntcumulative size @ ask price
OptProbModel124avgBLink1mFloataverage buy link value (trailing 10)
OptProbModel127maeBLink1mFloatbuy link value mean abs err (trailing 1000)
OptProbModel130avgSLink1mFloataverage sell link value (trailing 10)
OptProbModel133maeSLink1mFloatsell link value mean abs err (trailing 1000)
OptProbModel136avgBLink10mFloataverage buy link value (trailing 100)
OptProbModel139maeBLink10mFloatbid link value mean abs err (trailing 1000)
OptProbModel142avgSLink10mFloataverage ask link value (trailing 100)
OptProbModel145maeSLink10mFloatask link value mean abs err (trailing 1000)
OptProbModel148bCounterIntbuy counter
OptProbModel151sCounterIntsell counter
OptProbModel154prtTimestampLongfeed timestamp from the packet
OptProbModel157netTimestampLonginbound packet PTP timestamp from SR gateway switch (from OptionPrint)
OptProbModel160smsTimestampLongstate model server timestamp (just before publish)
mTokenField NumberField NameField TypeField Description
OptAnalytics10okeyOptionKey
OptAnalytics11prtNumberLongUnique print set identifier, will increment but not guaranteed to be sequential
OptAnalytics100fkeyExpiryKeyunderlying fkey (if any)
OptAnalytics103tickerTickerKeyunderlying ticker
OptAnalytics106prtExchEnumexchange on which print took place
OptAnalytics109prtSizeIntprint size [contracts]
OptAnalytics112prtPriceFloatprint price
OptAnalytics115prtTypeEnumprint type
OptAnalytics118prtOrdersUShortnumber of participating orders (future exchanges only)
OptAnalytics121prtClusterNumIntincremental print cluster counter (one counter per okey; used to group prints into clusters)
OptAnalytics124prtClusterSizeIntcumulative size of prints in this sequence (prints @ same or more aggressive price with less than 25 ms elapsing since first print; can span exchanges)
OptAnalytics127prtVolumeIntday print volume in contracts
OptAnalytics130cxlVolumeIntday print/cancel volume (num of contracts printed and then cancelled)
OptAnalytics133bidCountUShortnumber of bid prints
OptAnalytics136askCountUShortnumber of ask prints
OptAnalytics139bidVolumeIntbid print volume in contracts
OptAnalytics142askVolumeIntask print volume in contracts
OptAnalytics145ebidFloatexchange bid (@ print time)
OptAnalytics148easkFloatexchange ask (@ print time)
OptAnalytics151ebszIntexchange bid size
OptAnalytics154easzIntexchange ask size
OptAnalytics157eageFloatage of prevailing quote at time of print
OptAnalytics160prtSideEnum
OptAnalytics163prtTimestampLongexchange high precision timestamp (if available)
OptAnalytics166netTimestampLonginbound packet PTP timestamp from SR gateway switch; usually syncronized with facility grandfather clock
OptAnalytics169timestampDateTime
OptAnalytics172oBidFloatOption NBBO bid a the time the print was received
OptAnalytics175oAskFloatOption NBBO ask a the time the print was received
OptAnalytics178oBidSzIntOption NBBO cumulative bid size at the time the print was received
OptAnalytics181oAskSzIntOption NBBO cumulative ask size at the time the print was received
OptAnalytics184oBidExEnumFirst (or largest) option exchange on the bid
OptAnalytics187oAskExEnumFirst (or largest) option exchange on the ask
OptAnalytics190oBidExSzIntOption bid size of the largest exchange on the bid at the time the print was received
OptAnalytics193oAskExSzIntOption ask size of the largest exchange on the ask at the time the print was received
OptAnalytics196oBidCntByteNumber of exchanges on the NBBO bid
OptAnalytics199oAskCntByteNumber of exchanges on the NBBO ask
OptAnalytics202oBid2FloatSecond level bid price
OptAnalytics205oAsk2FloatSecond level ask price
OptAnalytics208oBidSz2IntCumulative size on the second level bid price
OptAnalytics211oAskSz2IntCumulative size on the second level ask price
OptAnalytics214uBidDoubleunderlier bid
OptAnalytics217uAskDoubleunderlier ask
OptAnalytics220uPrcDoubleunderlier price
OptAnalytics223yrsFloatyears to expiry
OptAnalytics226rateFloatinterest rate
OptAnalytics229sdivFloatcontinuous stock dividend
OptAnalytics232ddivFloatdiscrete stock dividend value (sum of dividends less than or equals to expiration)
OptAnalytics235xDeFloatxDelta
OptAnalytics238xAxisFloatSR surface xAxis value
OptAnalytics241multihedgeEnumDistinguishes options that have a single underlying security from those that are more complex: multiple securities,cash components, binary options,etc: ‘None’,‘Simple’,‘Complex’,‘AllCash’,‘Binary’
OptAnalytics244flexTypeEnum
OptAnalytics247flexRootString
OptAnalytics250prtIvFloatprint implied vol
OptAnalytics253prtDeFloatprint delta
OptAnalytics256prtGaFloatprint gamma
OptAnalytics259prtThFloatprint theta
OptAnalytics262prtVeFloatprint vega
OptAnalytics265prtRoFloatprint rho
OptAnalytics268calcErrStringcalc error flag
OptAnalytics271surfVolFloatSR surface volatility
OptAnalytics274surfOpxFloatSR surface price
OptAnalytics277surfAtmFloatSR surface ATM vol
OptAnalytics280prtProbabilityFloat[M1] probability that buying prtSize contracts @ prtPrice will have positive m10 pnl (prtPriceM10 greater than or equals to prtPrice) [recorded at time of print]
OptAnalytics283prtProbabilityM2Floatalternate probability model
OptAnalytics286prtProbabilityM3Floatalternate probability model
OptAnalytics289oBidM1FloatNBBO option bid 1 minute after print was received
OptAnalytics292oAskM1FloatNBBO option ask 1 minute after print was received
OptAnalytics295uBidM1DoubleNBBO underlying bid 1 minute after print was received
OptAnalytics298uAskM1DoubleNBBO underlying ask 1 minute after print was received
OptAnalytics301uPrcM1DoubleUnderlying price 1 minute after print was received
OptAnalytics304sVolM1FloatSuface volatility 1 minute after print was received
OptAnalytics307sOpxM1FloatSurface option price 1 minute after print was received
OptAnalytics310sDivM1FloatsDiv 1 minute after print was received
OptAnalytics313sErrM1StringSurface error condition (if any) 1 minute after print was received
OptAnalytics316pnlM1Floatpnl after 1 minute
OptAnalytics319pnlM1ErrEnumError condition for PnL calculated over the first 1 minute after the print was received
OptAnalytics322oBidM10FloatNBBO option bid 10 minutes after print was received
OptAnalytics325oAskM10FloatNBBO option ask 10 minutes after print was received
OptAnalytics328uBidM10DoubleNBBO underlying bid 10 minutes after print was received
OptAnalytics331uAskM10DoubleNBBO underlying ask 10 minutes after print was received
OptAnalytics334uPrcM10DoubleUnderlying price 10 minutes after print was received
OptAnalytics337sVolM10FloatSuface volatility 10 minutes after print was received
OptAnalytics340sOpxM10FloatSurface option price 10 minutes after print was received
OptAnalytics343sDivM10FloatsDiv 10 minutes after print was received
OptAnalytics346sErrM10StringSurface error condition (if any) 10 minutes after print was received
OptAnalytics349pnlM10Floatpnl after 10 minutes
OptAnalytics352pnlM10ErrEnumError condition for PnL calculated 10 minutes after the print was received
mTokenField NumberField NameField TypeField Description
OptProbModel10okeyOptionKey
OptProbModel11stateModelEnum
OptProbModel100uMidDoublereference underlier midPrice (0.5 prob price)
OptProbModel103uPrcDoublereference underlier price (mid-quote)
OptProbModel106bidPriceFloatnbbo bid price
OptProbModel109askPriceFloatnbbo ask price
OptProbModel112bidSizeIntcumulative size @ bid price
OptProbModel115askSizeIntcumulative size @ ask price
OptProbModel118bidTakeProbFloatbid take probability of current nbbo market (zero exchange fee) [average size print]
OptProbModel121askTakeProbFloatask take probability of current nbbo market (zero exchange fee) [average size print]
OptProbModel124bidTakeRvEnummodel result code
OptProbModel127askTakeRvEnummodel result code
OptProbModel130bidImprPriceFloattrial improvement price (usually 1 tick or 1/2 spread inside bidPrice)
OptProbModel133askImprPriceFloattrial improvement price (usually 1 tick or 1/2 spread inside askPrice)
OptProbModel136bidTkImProbFloatbid take imprv probability of current nbbo market (zero exchange fee) [prob to sell (take) @ bid + imprIncrement]
OptProbModel139askTkImProbFloatask take imprv probability of current nbbo market (zero exchange fee) [prob to buy (take) @ ask - imprIncrement]
OptProbModel142bidTkImRvEnummodel result code
OptProbModel145askTkImRvEnummodel result code
OptProbModel148surfPriceDoublesurface price
OptProbModel151surfVolDoublesurface volatility
OptProbModel154sdivDoubleexpiry sdiv
OptProbModel157surfBuyProbFloatsurface buy take probability (zero exchange fee) [average size print]
OptProbModel160surfSellProbFloatsurface sell take probability (zero exchange fee) [average size print]
OptProbModel163bSurfRvEnummodel result code
OptProbModel166sSurfRvEnummodel result code
OptProbModel169vegaFloatoption vega
OptProbModel172deltaFloatoption delta
OptProbModel175midPriceFloatprice corresponding to 0.50 probability
OptProbModel178avgBidLink10mFloataverage bid take prob link value (~10 min)
OptProbModel181maeBidLink10mFloatbid link value mean abs err (~10 min)
OptProbModel184avgAskLink10mFloataverage ask take prob link value (~10 min)
OptProbModel187maeAskLink10mFloatask link value mean abs err (~10 min)
OptProbModel190avgMktWidth10mFloataskPrice - bidPrice (~10 min)
OptProbModel193counterIntrecord update counter (zero @ start of period;per okey)
OptProbModel196qpSourceEnum
OptProbModel199srcTimestampLongfeed timestamp from the packet
OptProbModel202netTimestampLonginbound packet PTP timestamp from SR gateway switch (from OptionNbboQuote)
OptProbModel205smsTimestampLongstate model server timestamp (just before publish)
mTokenField NumberField NameField TypeField Description
OptAnalytics10okeyOptionKey
OptAnalytics100tickerTickerKey
OptAnalytics103svolFloatoption surface volatility
OptAnalytics106yearsFloatyears to expiration
OptAnalytics109up50Floatunderlier up 50% slide
OptAnalytics112dn50Floatunderlier dn 50% slide
OptAnalytics115up15Floatunderlier up 15% slide
OptAnalytics118dn15Floatunderlier dn 15% slide
OptAnalytics121up12Floatunderlier up 12% slide
OptAnalytics124dn12Floatunderlier dn 12% slide
OptAnalytics127up09Floatunderlier up 9% slide
OptAnalytics130dn09Floatunderlier dn 9% slide
OptAnalytics133dn08Floatunderlier dn 8% slide
OptAnalytics136up06Floatunderlier up 6% slide
OptAnalytics139dn06Floatunderlier dn 6% slide
OptAnalytics142up03Floatunderlier up 3% slide
OptAnalytics145dn03Floatunderlier dn 3% slide
OptAnalytics148calcErrStringoption pricing error, otherwise, an empty string.
OptAnalytics151calcSourceEnum
OptAnalytics154timestampDateTime
mTokenField NumberField NameField TypeField Description
MLinkRest100msgTypeUShortmessage type of the data object being ack’d
MLinkRest103sendTsLongsend timestamp of the data object being ack’d (note: MessageType + SendTimestamp should be unique)
MLinkRest106pkeyText1pkey (string) of the message being ack’d
MLinkRest109resultEnum
MLinkRest112detailText1
mTokenField NumberField NameField TypeField Description
FutureDefinition10secKeyOptionKeySR Security Key [can be partially filled in (look at secType)]
FutureDefinition11secTypeEnumSecurity Type [Stock, Future, Option]
FutureDefinition100securityIDStringunique exchange id (exch assigned)
FutureDefinition103tickerTickerKeymaster underlier
FutureDefinition106productClassEnum
FutureDefinition109underlierIDLongunderlier product id (option only) [securityID of undKey/undType product]
FutureDefinition112undKeyExpiryKeySR Underlier Security Key [can be partially filled in (look at undType)] (option only)
FutureDefinition115undTypeEnumUnderlier Security Type [Stock, Future] (option only)
FutureDefinition118productGroupStringUnderlying product code. I.E. All GE (Eurodollar) spreads, options, futures will be in the same productGroup - This is the Asset field from the SecurityDefinition message
FutureDefinition121securityGroupStringExchange specific code for a group of related securities that are all affected by market events. I.E. All E-mini weekly options (EW) - This is SecurityGroup field from the SecurityDefinition messages
FutureDefinition124marketSegmentIDIntExchange specific market segment identifier
FutureDefinition127securityDescStringfull exchange symbol
FutureDefinition130exchangeStringlisting exchange
FutureDefinition133productTypeEnum
FutureDefinition136productTermEnum
FutureDefinition139productIndexTypeEnum
FutureDefinition142productRateFloat
FutureDefinition145contractSizeFloat
FutureDefinition148contractUnitEnum
FutureDefinition151priceFormatEnum
FutureDefinition154minTickSizeDouble
FutureDefinition157displayFactorDouble
FutureDefinition160strikeScaleDoublemanual strike price adjustment multiplier (used for some CME products if set, otherwise displayFactor is used) (okey_xx = strikePrice * manualStrikeScale)
FutureDefinition163minLotSizeShortminimum lot size
FutureDefinition166bookDepthShortlevels in the Globex quote book
FutureDefinition169impliedBookDepthShortlevels in the globex implied quote book (0 if no implied depth)
FutureDefinition172impMarketIndShortimplied market type (0 = no implied, 1 = implied in, 2 = implied out, 3 = implied in & out)
FutureDefinition175minPriceIncrementAmountFloat(depricate) minimum price amount (points per handle)
FutureDefinition178parValueFloatper contract par value
FutureDefinition181contMultiplierFloatcontract deliverable multipler
FutureDefinition184cabPriceDouble(depricate) cabinet price (minimum closing price for OOM options)
FutureDefinition187tradeCurrEnum
FutureDefinition190settleCurrEnum
FutureDefinition193strikeCurrEnum
FutureDefinition196expirationDateTimefuture expiration or option expiration (if product is an option). we use the last TRADING day as the expiration date.
FutureDefinition199maturityDateKeyfuture maturity date or option maturity date. this is the delivery month.
FutureDefinition202exerciseTypeEnum(depricate; in RootDefinition) Exercise style
FutureDefinition205userDefinedEnum
FutureDefinition208decayStartYearShort
FutureDefinition211decayStartMonthByte
FutureDefinition214decayStartDayByte
FutureDefinition217decayQtyIntdaily decay quantity
FutureDefinition220priceRatioDoubleprice ratio for interest rate intercommodity spreads
FutureDefinition247timestampDateTime
FutureDefinition223LegsRepeater
FutureDefinition226legIDStringleg SecurityId (exch assigned)
FutureDefinition229secKeyOptionKey
FutureDefinition232secTypeEnum
FutureDefinition235sideEnum
FutureDefinition238ratioUShort
FutureDefinition241refDeltaFloat
FutureDefinition244refPrcDouble
mTokenField NumberField NameField TypeField Description
MLinkRest100numBytesSentLongnum bytes sent
MLinkRest103numMessagesSentLongnum messages sent
MLinkRest106numMessagesScannedLongnum messages scanned
MLinkRest109queryElapsedFloatquery elapsed time (seconds)
MLinkRest112resultEnumquery result
MLinkRest115detailText1query result detail
mTokenField NumberField NameField TypeField Description
OptionDefinition10rootTickerKey
OptionDefinition100tickerTickerKeymaster underlying (can be a stock/product group; eg. @ES)
OptionDefinition103osiRootStringlong version of the root. the short version is used in the TickerKey (for example RYAAY1, not RYAA1)
OptionDefinition106ccodeTickerKey
OptionDefinition109uPrcDriverKeyExpiryKey(optional) option underlier price driver (all option expiries) (overrides optExpiryDefinition)
OptionDefinition112uPrcDriverTypeEnumStock or Future (note: if Future and uPrcDriverKey does not have an expiry month then FrontMonth will be used)
OptionDefinition115uPrcDriverKey2ExpiryKey(optional) alternate option underlier price driver (all option expiries) (overrides optExpiryDefinition)
OptionDefinition118uPrcDriverType2EnumStock or Future (note: if Future and uPrcDriverKey does not have an expiry month then FrontMonth will be used)
OptionDefinition121uPrcBoundCCodeEnumif Yes and if a future exists with ccode=CCode and futExpiry = optExpiry the use this future as a pricing bound
OptionDefinition124expirationMapEnumdetermines the underlying future (if any)
OptionDefinition127underlierModeEnum
OptionDefinition130optionTypeEnumindicator for option type
OptionDefinition133multihedgeEnumindicates type of multihedge
OptionDefinition136exerciseTimeEnumExercise time type
OptionDefinition139exerciseTypeEnumExercise style
OptionDefinition142timeMetricEnumtrading time metric - 252 or 365 trading days or a weekly cycle type
OptionDefinition145pricingModelEnum
OptionDefinition148moneynessTypeEnummoneyness (xAxis) convention: PctStd = (K / fUPrc - 1) / (axisVol * RT), LogStd = LOG(K/fUPrc) / (axisVol * RT), NormStd = (K - fUPrc) / (axisVol * RT)
OptionDefinition151priceQuoteTypeEnumquoting style for the option series on the exchange, price (standard price quote) or volatility quoted (vol points)
OptionDefinition154volumeTierEnum
OptionDefinition157positionLimitIntmax contract limit
OptionDefinition160exchangesStringexchange codes
OptionDefinition163tickValueFloat$NLV value of a single tick change in display premium (pointValue = tickValue / tickSize)
OptionDefinition166pointValueFloat$NLV value of a single point change in display premium (pointValue = tickValue / tickSize)
OptionDefinition169pointCurrencyEnum
OptionDefinition172strikeScaleDoublemanual strike price adjustment multiplier (used for some CME products if set, otherwise displayFactor is used) (okey_xx = strikePrice * manualStrikeScale)
OptionDefinition175strikeRatioFloatnote: effective strike = strike * strikeRatio - cashOnExercise
OptionDefinition178cashOnExerciseFloatnote: cashOnExercise is positive if it decreases the effective strike price
OptionDefinition181underliersPerCnIntnote: always 100 if underlying list is in use
OptionDefinition184premiumMultDoublenote: OCC premium/strike multiplier (usually 100)
OptionDefinition187adjConventionEnum
OptionDefinition190optPriceIncEnum
OptionDefinition193priceFormatEnumprice display format
OptionDefinition196tradeCurrEnum
OptionDefinition199settleCurrEnum
OptionDefinition202strikeCurrEnum
OptionDefinition205defaultSurfaceRootTickerKeyfallback ticker to use for option surfaces if no native surfaces are available
OptionDefinition208timestampDateTime
OptionDefinition211UnderlyingRepeater
OptionDefinition214tickerTickerKey
OptionDefinition217spcFloatnote: _root basket = sum(spc * ticker) / 100
mTokenField NumberField NameField TypeField Description
OptSurface10tickerTickerKey
OptSurface100minXDoubletypically: -30
OptSurface103maxXDoubletypically: +30
OptSurface106numPointsInttypically: 601 (skew points are 0.10 xAxis pts apart)
OptSurface115timestampDateTime
OptSurface109PointRepeater
OptSurface112yyDoubleskew fn value at grid point (usually; yy= 1.0 @ x= 0.0)
mTokenField NumberField NameField TypeField Description
OptExchAuction10secKeyOptionKey
OptExchAuction11secTypeEnum
OptExchAuction12auctionExchEnumexchange handling the auction
OptExchAuction13auctionExDestStringexternal exDest of auction (usually means auction is off-exchange)
OptExchAuction100srAuctionIDLongunique SR AUCTION ID (required when responding to an auction notice)
OptExchAuction103exchAuctionIdString
OptExchAuction106exchAuctionTypeString
OptExchAuction109isTestAuctionEnumtest auction (should only respond from T.accnts)
OptExchAuction112auctionStateEnum
OptExchAuction115auctionShapeEnum
OptExchAuction118auctionTypeEnum
OptExchAuction121auctionSideEnumMarket side (client/imbalance side of auction; if known) [responder should be opposite side]
OptExchAuction124auctionSizeIntsize available to trade
OptExchAuction127auctionPriceDoubleauction price (can be positive or negative)
OptExchAuction130isAuctionPriceValidEnum
OptExchAuction133auctionDurationIntexpected auction / imbalance action duration (ms)
OptExchAuction136auctionStartSizeIntinitial (starting) auction size
OptExchAuction139auctionStartPriceDoubleinitial (starting) auction price
OptExchAuction142auctionStartTimestampLongauction start timestamp
OptExchAuction145minResponseSizeIntminimum size of the response order
OptExchAuction148limitTypeEnumclient / imbalance limit type (if available)
OptExchAuction151firmTypeEnumfirm type of the client side of auction (if available)
OptExchAuction154memberMPIDStringexchange member initiating auction (if available)
OptExchAuction157clientAccntStringclient account designation (if known)
OptExchAuction160otherDetailStringadditional auction detail (exchange specific)
OptExchAuction163matchedSizeIntsize already matched (may still be available to trade at a better price)
OptExchAuction166numUpdatesBytenumber of auction updates received (not counting auction termination message)
OptExchAuction169numResponsesByteas reported by exchange (if available)
OptExchAuction172bestResponseSizeInt
OptExchAuction175bestResponsePriceDouble
OptExchAuction178cumFillQuantityIntas reported by exchange (if available)
OptExchAuction181avgFillPriceDouble
OptExchAuction184marketStatusEnummarket status (pre-open, open, closed, etc)
OptExchAuction187srcTimestampLongsource timestamp (nanoseconds) if available
OptExchAuction190netTimestampLongnetwork timestamp message arrival @ direct exchange gateway
OptExchAuction193dgwTimestampLongnetwork timestamp mbus message send @ direct exchange gateway
OptExchAuction196timestampDateTime
OptExchAuction199LegsRepeater
OptExchAuction202legSecKeyOptionKey
OptExchAuction205legSecTypeEnum
OptExchAuction208legSideEnum
OptExchAuction211legRatioUShortleg ratio (1, 2, etc)
mTokenField NumberField NameField TypeField Description
SpreadMktData10skeyTickerKeySR Spread Key (should have corresponding ProductDefinition record)
SpreadMktData11isTestEnumYes indicates that response is made of entirely of isTest=Yes SpreadExchOrders
SpreadMktData100tickerTickerKeycommon spread underlier
SpreadMktData103priceFormatEnum
SpreadMktData106bidPrice1Doublebid price
SpreadMktData109isBidPrice1ValidEnum
SpreadMktData112askPrice1Doubleask price
SpreadMktData115isAskPrice1ValidEnum
SpreadMktData118bidSize1Intcumulative size at bidPrice
SpreadMktData121askSize1Intcumulative size at askPrice
SpreadMktData124bidMask1UIntexchange bid bit mask (OptExch mask for NMS spreads; zero for single exchange spreads)
SpreadMktData127askMask1UIntexchange ask bit mask (OptExch mask for NMS spreads; zero for single exchange spreads)
SpreadMktData130bidExch1Enumexchange at bid price with the largest size (if any)
SpreadMktData133askExch1Enumexchange at ask price with the largest size (if any)
SpreadMktData136bidTimeDateTimelast bid price or size change
SpreadMktData139askTimeDateTimelast ask price or size change
SpreadMktData142updateTypeEnum
SpreadMktData145numStkLegsByte
SpreadMktData148numFutLegsByte
SpreadMktData151numOptLegsByte
SpreadMktData154allLegsValidEnum
SpreadMktData157userDefinedEnum
SpreadMktData160spreadTypeEnumoption spread type
SpreadMktData163ratioTypeEnum
SpreadMktData166legBidPrcDouble
SpreadMktData169legAskPrcDouble
SpreadMktData172legBidSzInt
SpreadMktData175legAskSzInt
SpreadMktData178surfPrcDouble
SpreadMktData181surfDeltaFloat
SpreadMktData184surfGammaFloat
SpreadMktData187surfVegaFloat
SpreadMktData190surfWtVegaFloat
SpreadMktData193surfErrorByteerror code from surface price calc (if any)
SpreadMktData196minExpiryDateTimeexpiry of earliest option leg(s)
SpreadMktData199maxExpiryDateTimeexpiry of latest option leg(s)
SpreadMktData202minYearsFloat
SpreadMktData205maxYearsFloat
SpreadMktData208refUPrcFloatreference underlier price
SpreadMktData211printPriceFloatlast spread print price (if any)
SpreadMktData214printTimeDateTime
SpreadMktData217printSizeIntlast spread print size (if any)
SpreadMktData220printVolumeInt
SpreadMktData223grpNumInt
SpreadMktData226securityDescString
SpreadMktData229filterIdLongtool server filter request ID
SpreadMktData232timestampDateTime
SpreadMktData235MarkupLegsRepeater
SpreadMktData238legSecKeyOptionKey
SpreadMktData241legSecTypeEnum
SpreadMktData244legPriceFormatEnum
SpreadMktData247legSecurityDescStringSecurity description
SpreadMktData250legSideEnum
SpreadMktData253legRatioUShortleg ratio (1, 2, etc)
SpreadMktData256legBidPriceDoubleleg market bid
SpreadMktData259legBidSizeInt
SpreadMktData262legAskPriceDoubleleg market ask
SpreadMktData265legAskSizeInt
SpreadMktData268legYearsFloat
SpreadMktData271legUPrcDouble
SpreadMktData274legOptMultFloatSPC if equity, 1 if option/future
SpreadMktData277legFutMultFloat1 if equity, uMult if option/future
SpreadMktData280legSurfVolFloatleg surface volatility
SpreadMktData283legSurfPriceFloatsurface price as of message arrival
SpreadMktData286legSurfDeFloat
SpreadMktData289legSurfGaFloat
SpreadMktData292legSurfVeFloat
SpreadMktData295legSurfErrByte
mTokenField NumberField NameField TypeField Description
SpreadMktData10skeyTickerKeySR Spread Key (should have corresponding ProductDefinition record)
SpreadMktData11isTestEnumYes indicates that response is made of entirely of isTest=Yes SpreadExchOrders
SpreadMktData100tickerTickerKeycommon spread underlier
SpreadMktData103bidPrice1Doublebid price
SpreadMktData106isBidPrice1ValidEnum
SpreadMktData109askPrice1Doubleask price
SpreadMktData112isAskPrice1ValidEnum
SpreadMktData115bidSize1Intcumulative size at bidPrice
SpreadMktData118askSize1Intcumulative size at askPrice
SpreadMktData121bidPrice2Double2nd best bid price
SpreadMktData124isBidPrice2ValidEnum
SpreadMktData127askPrice2Double2nd best ask price
SpreadMktData130isAskPrice2ValidEnum
SpreadMktData133bidSize2Intcumulative size at 2nd price
SpreadMktData136askSize2Intcumulative size at 2nd price
SpreadMktData139bidExch1Enumexchange at bid price with the largest size (if any)
SpreadMktData142askExch1Enumexchange at ask price with the largest size (if any)
SpreadMktData145bidMask1UIntexchange bid bit mask (OptExch mask for NMS spreads; zero for single exchange spreads)
SpreadMktData148askMask1UIntexchange ask bit mask (OptExch mask for NMS spreads; zero for single exchange spreads)
SpreadMktData151bidTimeDateTimelast bid price or size change
SpreadMktData154askTimeDateTimelast ask price or size change
SpreadMktData157updateTypeEnum
SpreadMktData160srcTimestampLongsource high precision timestamp (if available)
SpreadMktData163netTimestampLonginbound packet PTP timestamp from SR gateway switch;usually syncronized with facility grandfather clock
SpreadMktData166timestampDateTime
mTokenField NumberField NameField TypeField Description
SpreadExchData10skeyTickerKeySR or exchange assigned Spread TickerKey (ProductDefinition.pkey) (might be null)
SpreadExchData11exchEnum
SpreadExchData12sideEnum
SpreadExchData13isTestEnum
SpreadExchData100tickerTickerKeyunderlier (or product group) tickerKey
SpreadExchData103orderIDStringexchange order ID
SpreadExchData106sizeInttotal spreads available
SpreadExchData109priceDouble
SpreadExchData112isPriceValidEnum
SpreadExchData115origOrderSizeIntoriginal order size (if available)
SpreadExchData118orderTypeEnum
SpreadExchData121orderStatusEnum
SpreadExchData124marketQualifierEnum
SpreadExchData127execQualifierEnum
SpreadExchData130timeInForceEnum
SpreadExchData133firmTypeEnum
SpreadExchData136clearingFirmString
SpreadExchData139clearingAccntString
SpreadExchData142srcTimestampLongsource high precision timestamp (if available)
SpreadExchData145netTimestampLongSpiderRock network PTP timestamp
SpreadExchData148dgwTimestampLongSpiderRock data gateway timestamp
SpreadExchData151timestampDateTime
SpreadExchData154LegsRepeater
SpreadExchData157legSecKeyOptionKey
SpreadExchData160legSecTypeEnum
SpreadExchData163legSideEnum
SpreadExchData166legRatioUIntleg ratio (1, 2, etc)
SpreadExchData169positionTypeEnum
mTokenField NumberField NameField TypeField Description
OptAnalytics10tickerTickerKey
OptAnalytics100statusEnum
OptAnalytics103betaFloat(depricate)
OptAnalytics106betaIndFloatSR beta to IND
OptAnalytics109betaSubFloatSR beta to SUB
OptAnalytics112betaGrpFloatSR beta to GRP
OptAnalytics115betaQQQFloatSR beta to QQQ [2 year; weekly (fri - fri)]
OptAnalytics118betaSPYFloatSR beta to SPY [2 year; weekly (fri - fri)]
OptAnalytics121betaIWMFloatSR beta to IWM [2 year; weekly (fri - fri)]
OptAnalytics124timestampDateTimerecord update timestamp
mTokenField NumberField NameField TypeField Description
EqtMktData10tickerTickerKey
EqtMktData100updateTypeEnum
EqtMktData103marketStatusEnummarket status (open, halted, etc)
EqtMktData106bidPrice1Floatbid price for best price level
EqtMktData109bidSize1Intbid size for best price level
EqtMktData112bidExch1Enum
EqtMktData115bidMask1UIntbid exchange bit mask for best bid price level
EqtMktData118askPrice1Floatask price for best price level
EqtMktData121askSize1Intask size for best price level
EqtMktData124askExch1Enumexchange
EqtMktData127askMask1UIntask exchange bit mask for best ask price level
EqtMktData130bidPrice2Floatbid price for next best price level
EqtMktData133bidSize2Intbid size for next best price level
EqtMktData136bidExch2Enumexchange
EqtMktData139bidMask2UIntbid exchange bit mask for next best bid price level
EqtMktData142askPrice2Floatask price for next best price level
EqtMktData145askSize2Intask size for next best price level
EqtMktData148askExch2Enumexchange
EqtMktData151askMask2UIntask exchange bit mask for next best ask price level
EqtMktData154haltMaskUIntbit mask of halted exchanges
EqtMktData157srcTimestampLongsource high precision timestamp (if available)
EqtMktData160netTimestampLonginbound packet PTP timestamp from SR gateway switch;usually syncronized with facility grandfather clock
mTokenField NumberField NameField TypeField Description
EqtMarkData10tickerTickerKey
EqtMarkData100tradeDateDateKey
EqtMarkData103clsMarkStateEnumClose mark state. None; LastPrt; SRClose; ExchClose; Final
EqtMarkData106opnPrcFloatOpen price
EqtMarkData109minPrcFloatLow price
EqtMarkData112maxPrcFloatHigh price
EqtMarkData115sharesOutstandingIntShares outstanding
EqtMarkData118prtCountIntPrint count
EqtMarkData121prtVolumeIntPrint volume
EqtMarkData124realizedVolFloatRealized vol
EqtMarkData127avgMktSizeFloatAverage market size
EqtMarkData130avgMktWidthFloatAverage market width
EqtMarkData133bidPrcFloatbid price (close - 1min)
EqtMarkData136askPrcFloatask price (close - 1min)
EqtMarkData139srClsPrcFloatSR close mark (close - 1min)
EqtMarkData142closePrcFloatofficial exchange closing mark (last print; then official close)
EqtMarkData145hasSRClsPrcEnum
EqtMarkData148hasClosePrcEnum
EqtMarkData151srCloseMarkDttmDateTimefrom MarketCloseQuote.srCloseMarkDttm
EqtMarkData154timestampDateTimerecord publish/update timestamp
mTokenField NumberField NameField TypeField Description
GlobalDefinition10tickerTickerKey
GlobalDefinition11sourceEnumLive=currentEarningsDate; priorDay=previousEarningsDate
GlobalDefinition100eMoveHistFloathistorical average (trailing 8) earnings moves prior to today
GlobalDefinition103timestampDateTimetimestamp of record
GlobalDefinition106EventRepeater
GlobalDefinition109eventDateDateKey
GlobalDefinition112eventTimeString
GlobalDefinition115earnStatusEnum
GlobalDefinition118guidanceIssuedEnum
GlobalDefinition121earnFiscalQtrDateKey
GlobalDefinition124earnChangeEnum
GlobalDefinition127earnPctMoveFloatunderlying move in the trading period including the event (only available when eventStatus = ‘Actual’)
GlobalDefinition130prvCloseFloatclosing price prior to earnings announcement
GlobalDefinition133openFloatopening price (on moveDate)
GlobalDefinition136highFloathigh price (on moveDate)
GlobalDefinition139lowFloatlow price (on moveDate)
GlobalDefinition142closeFloatclose price (on moveDate)
GlobalDefinition145moveDateDateKeydate corresponding to larger daily change (OHLC data taken from the same date or the date following each earnings announcement)
GlobalDefinition148hEMoveFloathistorical average (trailing 8) earnings moves prior to announcement (historical only)
mTokenField NumberField NameField TypeField Description
EqtExchImbalance10tickerTickerKey
EqtExchImbalance11auctionTimeDateTimeProjected Auction Time (hhmm).
EqtExchImbalance12auctionTypeEnum
EqtExchImbalance13exchangeEnum
EqtExchImbalance100referencePxFloatFor Pillar-powered markets, the Reference Price is used to calculate the Indicative Match Price.
EqtExchImbalance103pairedQtyIntFor Pillar-powered markets, the number of shares paired off at the Indicative Match Price.
EqtExchImbalance106totalImbalanceQtyIntFor Pillar-powered markets, the total imbalance quantity at the Indicative Match Price.
EqtExchImbalance109marketImbalanceQtyIntFor Pillar-powered markets, the total market order imbalance quantity at the Indicative Match Price.
EqtExchImbalance112imbalanceSideEnumThe side of the TotalImbalanceQty.
EqtExchImbalance115continuousBookClrPxFloatFor Pillar-powered markets, the price at which all interest on the book can trade, including auction and imbalance offset interest, and disregarding auction collars.
EqtExchImbalance118closingOnlyClrPxFloatFor Pillar-powered markets, the price at which all eligible auction-only interest would trade, subject to auction collars.
EqtExchImbalance121ssrFillingPxFloatFor Pillar-powered markets, not supported and defaulted to 0.
EqtExchImbalance124indicativeMatchPxFloatFor Pillar-powered markets, the price that has the highest executable volume of auction-eligible shares, subject to auction collars. It includes the non-displayed quantity of Reserve Orders.
EqtExchImbalance127upperCollarFloatIf the IndicativeMatchPrice is not strictly between the UpperCollar and the LowerCollar, special auction rules apply. See Rule 7.35P for details.
EqtExchImbalance130lowerCollarFloatIf the IndicativeMatchPrice is not strictly between the UpperCollar and the LowerCollar, special auction rules apply. See Rule 7.35P for details.
EqtExchImbalance133auctionStatusEnumIndicates whether the auction will run.
EqtExchImbalance136freezeStatusEnum
EqtExchImbalance139numExtensionsByteNumber of times the halt period has been extended.
EqtExchImbalance142netTimestampLongPTP timestamp
mTokenField NumberField NameField TypeField Description
EqtSummaryData10tickerTickerKey
EqtSummaryData100opnPriceDoublefirst print price of the day during regular market hours
EqtSummaryData103mrkPriceDoublelast print handled during regular market hours
EqtSummaryData106clsPriceDoubleofficial exchange closing price
EqtSummaryData109minPriceDoubleminimum print price within market hours
EqtSummaryData112maxPriceDoublemaximum print price within market hours
EqtSummaryData115sharesOutstandingIntshares outstanding
EqtSummaryData118bidCountIntnum prints less than or equals to quote.bid
EqtSummaryData121bidVolumeIntvolume when prtPrice less than or equals to quote.bid
EqtSummaryData124askCountIntnum prints greater than or equals to quote.ask
EqtSummaryData127askVolumeIntvolume when prtPrice greater than or equals to quote.ask
EqtSummaryData130midCountIntnum prints inside quote.bid / quote.ask
EqtSummaryData133midVolumeIntvolume inside quote.bid / quote.ask
EqtSummaryData136prtCountIntnumber of distinct print reports
EqtSummaryData139prtPriceDoublelast print price
EqtSummaryData142expCountIntnumber of updates included in exponential average
EqtSummaryData145expWidthDoubleexponential average market width (10 minute 1/2 life)
EqtSummaryData148expBidSizeFloatexponential average bid size (10 minute 1/2 life)
EqtSummaryData151expAskSizeFloatexponential average ask size (10 minute 1/2 life)
EqtSummaryData154lastPrintDateTime
EqtSummaryData157timestampDateTime
mTokenField NumberField NameField TypeField Description
EqtSummaryData10tickerTickerKey
EqtSummaryData100dateString
EqtSummaryData103timeString
EqtSummaryData106prtOpenDoubleOpen print
EqtSummaryData109prtHighDoubleHigh print
EqtSummaryData112prtLowDoubleLow print
EqtSummaryData115prtLastDoubleLast print
EqtSummaryData118prtVWapDoubleVWap (print)
EqtSummaryData121prtVolumeIntPrint volume
EqtSummaryData124prtCountIntPrint count
EqtSummaryData127qteHiBidDoubleQuote high bid
EqtSummaryData130qteLoAskDoubleQuote low ask
EqtSummaryData133qteTwapDoubleQuote TWap
EqtSummaryData136qteCountIntQuote count
EqtSummaryData139bidDoubleBid
EqtSummaryData142askDoubleAsk
EqtSummaryData145bidSzIntBid size
EqtSummaryData148askSzIntAsk size
EqtSummaryData151widthFloatBid/ask spread
EqtSummaryData154isEOBEnumis end-of-bar (every 10 minutes)
EqtSummaryData157isEOHEnumis end-of-hour
EqtSummaryData160timestampDateTimesame as date + time
mTokenField NumberField NameField TypeField Description
EqtMarkData10tickerTickerKey
EqtMarkData100tradeDateDateKey
EqtMarkData103srClsPrcFloatSR open mark; [SR close market (close - 1 min) from previous day; overnight adjusted]
EqtMarkData106closePrcFloatexchange open mark; [exchange close mark from previous day; overnight adjusted]
EqtMarkData109bidPrcFloatbid price [SR closing bid (close - 1 min) from previous day; overnight adjusted]
EqtMarkData112askPrcFloatask price [SR closing ask (close - 1 min) from previous day; overnight adjusted]
EqtMarkData115corpActionText1
EqtMarkData118timestampDateTime
mTokenField NumberField NameField TypeField Description
EqtMktData10tickerTickerKey
EqtMktData100prtExchEnumprint exch
EqtMktData103prtSizeIntprint size
EqtMktData106prtPriceFloatprint price level
EqtMktData109prtClusterNumIntincremental print cluster counter (one counter per ticker; used to group prints into clusters)
EqtMktData112prtClusterSizeIntcumulative size of prints in this sequence (prints @ same or more aggressive price with less than 25 ms elapsing since first print; can span exchanges)
EqtMktData115prtVolumeIntcumulative print size today
EqtMktData118mrkPriceFloatlast regular market print price
EqtMktData121clsPriceFloatofficial closing price (if available)
EqtMktData124prtTypeEnum
EqtMktData127prtCond1Byteprint condition (from SIP feed)
EqtMktData130prtCond2Byte
EqtMktData133prtCond3Byte
EqtMktData136prtCond4Byte
EqtMktData139ebidFloatexchange bid (@ print time) [SIP feed]
EqtMktData142easkFloatexchange ask (@ print time) [SIP feed]
EqtMktData145ebszIntexchange bid size
EqtMktData148easzIntexchange ask size
EqtMktData151eageFloatage of prevailing quote at time of print
EqtMktData154prtSideEnum
EqtMktData157prtTimestampLongexchange high precision timestamp (if available)
EqtMktData160netTimestampLonginbound packet PTP timestamp from SR gateway switch; usually syncronized with facility grandfather clock
EqtMktData163timestampDateTime
mTokenField NumberField NameField TypeField Description
StkProbModel10tickerTickerKey
StkProbModel11stateModelEnum
StkProbModel100prtPriceFloat
StkProbModel103prtSizeInt
StkProbModel106prtProbFloatprobability that this print will result in positive PnL
StkProbModel109prtSideEnum
StkProbModel112bidPriceFloatnbbo bid price
StkProbModel115askPriceFloatnbbo ask price
StkProbModel118bidSizeIntcumulative size @ bid price
StkProbModel121askSizeIntcumulative size @ ask price
StkProbModel124avgBLink1mFloataverage buy link value (trailing 10)
StkProbModel127maeBLink1mFloatbuy link value mean abs err (trailing 1000)
StkProbModel130avgSLink1mFloataverage sell link value (trailing 10)
StkProbModel133maeSLink1mFloatsell link value mean abs err (trailing 1000)
StkProbModel136avgBLink10mFloataverage buy link value (trailing 100)
StkProbModel139maeBLink10mFloatbid link value mean abs err (trailing 1000)
StkProbModel142avgSLink10mFloataverage ask link value (trailing 100)
StkProbModel145maeSLink10mFloatask link value mean abs err (trailing 1000)
StkProbModel148bCounterIntbuy counter
StkProbModel151sCounterIntsell counter
StkProbModel154prtTimestampLongfeed timestamp from the packet
StkProbModel157netTimestampLonginbound packet PTP timestamp from SR gateway switch (from StockPrint);
StkProbModel160smsTimestampLongstate model server timestamp (just before publish)
mTokenField NumberField NameField TypeField Description
StkProbModel10tickerTickerKey
StkProbModel11stateModelEnum
StkProbModel100bidPriceFloatnbbo bid price
StkProbModel103askPriceFloatnbbo ask price
StkProbModel106bidSizeIntcumulative size @ bid price
StkProbModel109askSizeIntcumulative size @ ask price
StkProbModel112bidTakeProbFloatbid take probability of current nbbo market (zero exchange fee) [average size print]
StkProbModel115askTakeProbFloatask take probability of current nbbo market (zero exchange fee) [average size print]
StkProbModel118bidTakeRvEnum
StkProbModel121askTakeRvEnummodel result code
StkProbModel124bidImprPriceFloattrial improvement price (usually 1 tick or 1/2 spread inside bidPrice)
StkProbModel127askImprPriceFloattrial improvement price (usually 1 tick or 1/2 spread inside askPrice)
StkProbModel130bidTkImProbFloatbid take imprv probability of current nbbo market (zero exchange fee) [prob to sell (take) @ bid + imprIncrement]
StkProbModel133askTkImProbFloatask take imprv probability of current nbbo market (zero exchange fee) [prob to buy (take) @ ask - imprIncrement]
StkProbModel136bidTkImRvEnummodel result code
StkProbModel139askTkImRvEnummodel result code
StkProbModel142midPriceFloatprice corresponding to 0.50 probability
StkProbModel145avgBidLink1mFloataverage bid link value (~1 min)
StkProbModel148maeBidLink1mFloatbid link value mean abs err (~10 min)
StkProbModel151avgAskLink1mFloataverage ask link value (~1 min)
StkProbModel154maeAskLink1mFloatask link value mean abs err (~1 min)
StkProbModel157avgBidLink10mFloataverage bid link value (~10 min)
StkProbModel160maeBidLink10mFloatbid link value mean abs err (~10 min)
StkProbModel163avgAskLink10mFloataverage ask link value (~10 min)
StkProbModel166maeAskLink10mFloatask link value mean abs err (~10 min)
StkProbModel169avgMktWidth1mFloataskPrice - bidPrice (~1 min)
StkProbModel172avgMktWidth10mFloataskPrice - bidPrice (~10 min)
StkProbModel175counterIntrecord update counter (zero @ start of period;per ticker)
StkProbModel178qpSourceEnum
StkProbModel181srcTimestampLongfeed timestamp from the packet
StkProbModel184netTimestampLonginbound packet PTP timestamp from SR gateway switch (from StockBookQuote);zero = size only change
StkProbModel187smsTimestampLongstate model server timestamp (just before publish)
mTokenField NumberField NameField TypeField Description
EquityDefinition10tickerTickerKey
EquityDefinition100securityIDIntSecurity ID number from the source - Vendor, SR, Feed
EquityDefinition103symbolTypeEnum
EquityDefinition106nameStringSymbol name
EquityDefinition109countryStringISO Issuer Country Code
EquityDefinition112parValueFloatSecurity Parvalue
EquityDefinition115parValueCurrencyStringSecurity Parvalue currency
EquityDefinition118pointValueFloat
EquityDefinition121pointCurrencyEnum
EquityDefinition124primaryExchEnum
EquityDefinition127altIDIntAlt Security ID number
EquityDefinition130micStringISO Market Identification Code
EquityDefinition133micSegStringISO Market Indentification Segment Code
EquityDefinition136symbolStringtrading symbol (w/o dot notation)
EquityDefinition139issueClassStringissue class of stock symbol. if no issue class field will be blank.
EquityDefinition142sharesOutstandingIntsymbol shares outstanding, represented in thousands (actualsharesoutstanding = sharesoutstanding * 1000)
EquityDefinition145cusipStringcusip code
EquityDefinition148indNumIntIND (2 digits)
EquityDefinition151subNumIntSUB (4 digits)
EquityDefinition154grpNumIntGRP (6 digits)
EquityDefinition157nbrNumIntNBR (8 digits)
EquityDefinition160sicStringSIC (Standard Industrial Classification) code
EquityDefinition163cikStringCentral Index Key (US specific)
EquityDefinition166gicsStringGlobal Industry Classification Standard
EquityDefinition169leiStringLegal Entity Identifier
EquityDefinition172naicsStringNorth American Industry Classification System
EquityDefinition175cfiStringISO Classification of Financial Instruments
EquityDefinition178cicStringComplementay Identification Code
EquityDefinition181fisnStringFinancial Instrument Short Name
EquityDefinition184isinStringISIN code
EquityDefinition187figiStringFIGI code
EquityDefinition190bbgCompositeTickerStringBloomberg Composite Ticker
EquityDefinition193bbgExchangeTickerStringBloomberg Exchange Ticker
EquityDefinition196bbgCompositeGlobalIDStringBloomberg Composite Global ID
EquityDefinition199bbgGlobalIDStringBloomberg Global ID
EquityDefinition202bbgCurrencyStringBloomberg Trading Currency
EquityDefinition205otcPrimaryMarketEnum
EquityDefinition208otcTierEnum
EquityDefinition211otcReportingStatusString
EquityDefinition214otcDisclosureStatusInt
EquityDefinition217otcFlagsInt
EquityDefinition220stkPriceIncEnumPrice increment: None; FullPenny; Nickle
EquityDefinition223tkDefSourceEnumTicker definition source: None; Vendor; OTC; SR; Exchange
EquityDefinition226statusFlagEnum
EquityDefinition229tapeCodeEnumSIP Tape Code
EquityDefinition232stkVolumeFloattrailing average 20D daily stock volume
EquityDefinition235futVolumeFloattrailing average 20D daily future volume
EquityDefinition238optVolumeFloattrailing average 20D daily option volume
EquityDefinition241exchStringStringexchanges listing any options on this underlying
EquityDefinition244hasOptionsEnumHas Options flag
EquityDefinition247numOptionsInttotal number of listed options
EquityDefinition250timeMetricEnumtrading time metric - 252 or 365 trading days or a weekly cycle type
EquityDefinition253timestampDateTime
Protocol usageClientBasicStream
twittergithublinkedin
Powered by Mintlify
Assistant
Responses are generated using AI and may contain mistakes.