Skip to main content
Version: 8.4.12.1

Schema: OptionNbboQuote (ID: 2785)

This table contains live option quote records from OPRA (equities) or the listing exchange (futures). Each record contains up to two price levels and represents a live snapshot of the book for a specific option series. There are typically 1mm+ records in this table if all ticker sources are enabled.

METADATA​

AttributeValue
Topic2750-market-data-options
MLink TokenOptMktData
SRSE ProductSRLive

Note: The symbol = next to a field number indicates that it is a primary key.

BODY​

#FieldTypeComment
10=okeyOptionKey
100updateTypeenum : UpdateType
103bidPricefloatbid price
106askPricefloatask price
109bidSizeintbid size in contracts (largest exch quote)
112askSizeintask size in contracts (largest exch quote)
115cumBidSizeintbid size in contracts (total nbbo size)
118cumAskSizeintask size in contracts (total nbbo size)
121bidExchenum : OptExchfirst (or largest remaining) exchange at bid price
124askExchenum : OptExchfirst (or largest remaining) exchange at ask price
127bidMaskuintexchange bid bit mask
130askMaskuintexchange ask bit mask
133bidMktTypeflag : OptMktTypebid side quote flags (if any)
136askMktTypeflag : OptMktTypeask side quote flags (if any)
139bidPrice2float2nd best bid price
142askPrice2float2nd best ask price
145cumBidSize2intcumulative size at 2nd price
148cumAskSize2intcumulative size at 2nd price
151bidTimeintlast bid price change (milliseconds since midnight) calculated from the srcTimestamp
154askTimeintlast ask price change (milliseconds since midnight) calculated from the srcTimestamp
157srcTimestamplongsource high precision timestamp (if available)
160netTimestamplonginbound packet PTP timestamp from SR gateway switch;usually syncronized with facility grandfather clock

Get Schema API Call​

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'OptionNbboQuote'

# Request Parameters for Get Schema Of The MsgType
params = {
#Required Parameters
"apiKey": API_KEY,
"cmd": 'getschema',
"msgType": MSG_TYPE, 
}

response = requests.get(MLINK_PROD_URL, params=params)

Get Msg API Call​

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'OptionNbboQuote'

# Replace with your pkey value for getting the specific message desired
PKEY = 'ReplaceThisValueForTheQueryToWork'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned. 
VIEW = 'updateType|bidPrice|askPrice|bidSize|askSize|cumBidSize|cumAskSize|bidExch|askExch|bidMask|askMask|bidMktType|askMktType|bidPrice2|askPrice2|cumBidSize2|cumAskSize2|bidTime|askTime|srcTimestamp|netTimestamp'

# Replace with your desired where clause.
# a string in the form "field1:eq:valuse" or "(field1:ne:value1 & field1:ne:value2)
# "WHERE" clauses can contain the following comparison symbols:
# :gt: is greater than
# :ge: is greater than or equal to
# :lt: is less than
# :le: is less than or equal to
# :eq: is equal
# :ne: is not equal
# %26 is an AND statement
# | is an OR statement
# :sw: is starts with
# :ew: is ends with
# :cv: is contains values
# :nv: is does not contain value
# :cb: is contained between (two dates for instance) separated by '$'
WHERE = ''

# Request Parameters for getmsg Of The MsgType
params = {
    # Required Parameters
    "apiKey": API_KEY,
    "cmd": 'getmsg',
    "pkey": PKEY,
    "msgType": MSG_TYPE,
    # Optional Parameters
    "view": VIEW, 
    "where": WHERE
}

response = requests.get(MLINK_PROD_URL, params=params)

Get Msgs API Call​

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'OptionNbboQuote'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'updateType|bidPrice|askPrice|bidSize|askSize|cumBidSize|cumAskSize|bidExch|askExch|bidMask|askMask|bidMktType|askMktType|bidPrice2|askPrice2|cumBidSize2|cumAskSize2|bidTime|askTime|srcTimestamp|netTimestamp'

# Replace with your desired where clause.
# a string in the form "field1:eq:value" or "(field1:ne:value1 & field1:ne:value2)
# "WHERE" clauses can contain the following comparison symbols:
# :gt: is greater than
# :ge: is greater than or equal to
# :lt: is less than
# :le: is less than or equal to
# :eq: is equal
# :ne: is not equal
# %26 is an AND statement
# | is an OR statement
# :sw: is starts with
# :ew: is ends with
# :cv: is contains values
# :nv: is does not contain value
# :cb: is contained between (two dates for instance) separated by '$'
WHERE = ''

# Replace with your desired limit of how many messages you receive. The default limit is 500
LIMIT = 500

# Order clause eg. "(field1:DESC | field1:ASC | field2:DESC:ABS | field2:ASC:ABS" (default is unordered; default is faster)
ORDER = 'updateType:ASC'

# Request Parameters for getmsgs Of The MsgType
params = {
    # Required Parameters
    "apiKey": API_KEY,
    "cmd": 'getmsgs',
    "msgType": MSG_TYPE,
    # Optional Parameters
    "view": VIEW, 
    "where": WHERE,
    "limit": LIMIT,
    "order": ORDER
}

response = requests.get(MLINK_PROD_URL, params=params)

Get Aggregate API Call​

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'OptionNbboQuote'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'updateType|bidPrice|askPrice|bidSize|askSize|cumBidSize|cumAskSize|bidExch|askExch|bidMask|askMask|bidMktType|askMktType|bidPrice2|askPrice2|cumBidSize2|cumAskSize2|bidTime|askTime|srcTimestamp|netTimestamp'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'updateType|bidExch|askExch'

# Replace with your desired where clause.
# a string in the form "field1:eq:value" or "(field1:ne:value1 & field1:ne:value2)
# "WHERE" clauses can contain the following comparison symbols:
# :gt: is greater than
# :ge: is greater than or equal to
# :lt: is less than
# :le: is less than or equal to
# :eq: is equal
# :ne: is not equal
# %26 is an AND statement
# | is an OR statement
# :sw: is starts with
# :ew: is ends with
# :cv: is contains values
# :nv: is does not contain value
# :cb: is contained between (two dates for instance) separated by '$'
WHERE = ''

# Request Parameters for getaggregate Of The MsgType
params = {
# Required Parameters
"apiKey": API_KEY,
"cmd": 'getaggregate',
"msgType": MSG_TYPE,
"measure": MEASURE,
"group": GROUP,
# Optional Parameters
"where": WHERE,
}

response = requests.get(MLINK_PROD_URL, params=params)

Get Count API Call​

import requests 

# Replace with your desired MLINK URL 
MLINK_PROD_URL = 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json'

# Replace with your MLINK API Key
API_KEY = 'XXXX-XXXX-XXXX-XXXX'

# Replace with your desired MsgType.  
MSG_TYPE = 'OptionNbboQuote'

# Replace with your desired where clause.
# a string in the form "field1:eq:value" or "(field1:ne:value1 & field1:ne:value2)
# "WHERE" clauses can contain the following comparison symbols:
# :gt: is greater than
# :ge: is greater than or equal to
# :lt: is less than
# :le: is less than or equal to
# :eq: is equal
# :ne: is not equal
# %26 is an AND statement
# | is an OR statement
# :sw: is starts with
# :ew: is ends with
# :cv: is contains values
# :nv: is does not contain value
# :cb: is contained between (two dates for instance) separated by '$'
WHERE = ''

# Request Parameters for getCount Of The MsgType
params = {
# Required Parameters
"apiKey": API_KEY,
"cmd": 'getcount',
"msgType": MSG_TYPE,
# Optional Parameters
"where": WHERE,
}

response = requests.get(MLINK_PROD_URL, params=params)