Skip to main content
Version: 8.4.10.2

Schema: OptionPrintProbability (ID: 4265)

METADATA​

AttributeValue
Topic4255-probabilities
MLink TokenOptProbModel
SRSE ProductSRLive, SRAnalytics

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

BODY​

#FieldTypeComment
10=okeyOptionKey
11=stateModelenum : StateModel
100prtPricefloat
103prtSizeint
106prtProbfloatprobability that this print will result in positive PnL
109prtSideenum : BuySell
112bidPricefloatnbbo bid price
115askPricefloatnbbo ask price
118bidSizeintcumulative size @ bid price
121askSizeintcumulative size @ ask price
124avgBLink1mfloataverage buy link value (trailing 10)
127maeBLink1mfloatbuy link value mean abs err (trailing 1000)
130avgSLink1mfloataverage sell link value (trailing 10)
133maeSLink1mfloatsell link value mean abs err (trailing 1000)
136avgBLink10mfloataverage buy link value (trailing 100)
139maeBLink10mfloatbid link value mean abs err (trailing 1000)
142avgSLink10mfloataverage ask link value (trailing 100)
145maeSLink10mfloatask link value mean abs err (trailing 1000)
148bCounterintbuy counter
151sCounterintsell counter
154prtTimestamplongfeed timestamp from the packet
157netTimestamplonginbound packet PTP timestamp from SR gateway switch (from OptionPrint)
160smsTimestamplongstate model server timestamp (just before publish)

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 = 'OptionPrintProbability'

# 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 = 'OptionPrintProbability'

# 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 = 'prtPrice|prtSize|prtProb|prtSide|bidPrice|askPrice|bidSize|askSize|avgBLink1m|maeBLink1m|avgSLink1m|maeSLink1m|avgBLink10m|maeBLink10m|avgSLink10m|maeSLink10m|bCounter|sCounter|prtTimestamp|netTimestamp|smsTimestamp'

# 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 = 'OptionPrintProbability'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'prtPrice|prtSize|prtProb|prtSide|bidPrice|askPrice|bidSize|askSize|avgBLink1m|maeBLink1m|avgSLink1m|maeSLink1m|avgBLink10m|maeBLink10m|avgSLink10m|maeSLink10m|bCounter|sCounter|prtTimestamp|netTimestamp|smsTimestamp'

# 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 = 'prtPrice: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 = 'OptionPrintProbability'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'prtPrice|prtSize|prtProb|prtSide|bidPrice|askPrice|bidSize|askSize|avgBLink1m|maeBLink1m|avgSLink1m|maeSLink1m|avgBLink10m|maeBLink10m|avgSLink10m|maeSLink10m|bCounter|sCounter|prtTimestamp|netTimestamp|smsTimestamp'

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

# 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 = 'OptionPrintProbability'

# 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)