Skip to main content
Version: Upcoming

Schema: SpdrSweepDetail (ID: 2330)

SpdrSweepDetail records are published by execution engines when sweep trigger groups are processed

METADATA​

AttributeValue
Topic2270-execution-engine
MLink TokenClientTrading
SRSE ProductSRTrade

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

BODY​

#FieldTypeComment
10=parentNumberlong
194engineNamestring(32)SpiderRock execution engine that handled the parent order
103accntstring(16)
106clientFirmstring(16)
109riskGroupIdlong
112triggerGroupIdlongWaitTrigger group Id
115secKeyOptionKey
118secTypeenum : SpdrKeyType
121parentOrderSizeint
124parentLimitPricedouble
127orderSideenum : BuySell
130isISOSweepenum : YesNo
133riskLimitSizeint
136riskLimitReasonenum : SpdrRisk
139riskLimitDetailtext1
142nbboBid1double
145nbboAsk1double
148nbboBidSize1int
151nbboAskSize1int
154nbboBidCnt1byte
157nbboAskCnt1byte
160nbboBidMask1uint
163nbboAskMask1uint
166nbboBid2double
169nbboAsk2double
172nbboBidSize2int
175nbboAskSize2int
178nbboBidCnt2byte
181nbboAskCnt2byte
184nbboBidMask2uint
187nbboAskMask2uint
190netTimestamplong
193timestampDateTime

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

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

# 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 = 'engineName|accnt|clientFirm|riskGroupId|triggerGroupId|secKey|secType|parentOrderSize|parentLimitPrice|orderSide|isISOSweep|riskLimitSize|riskLimitReason|riskLimitDetail|nbboBid1|nbboAsk1|nbboBidSize1|nbboAskSize1|nbboBidCnt1|nbboAskCnt1|nbboBidMask1|nbboAskMask1|nbboBid2|nbboAsk2|nbboBidSize2|nbboAskSize2|nbboBidCnt2|nbboAskCnt2|nbboBidMask2|nbboAskMask2|netTimestamp|timestamp'

# 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 = 'engineName:eq:ExampleString'

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

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'engineName|accnt|clientFirm|riskGroupId|triggerGroupId|secKey|secType|parentOrderSize|parentLimitPrice|orderSide|isISOSweep|riskLimitSize|riskLimitReason|riskLimitDetail|nbboBid1|nbboAsk1|nbboBidSize1|nbboAskSize1|nbboBidCnt1|nbboAskCnt1|nbboBidMask1|nbboAskMask1|nbboBid2|nbboAsk2|nbboBidSize2|nbboAskSize2|nbboBidCnt2|nbboAskCnt2|nbboBidMask2|nbboAskMask2|netTimestamp|timestamp'

# 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 = 'engineName:eq:ExampleString'

# 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 = 'engineName: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 = 'SpdrSweepDetail'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'engineName|accnt|clientFirm|riskGroupId|triggerGroupId|secKey|secType|parentOrderSize|parentLimitPrice|orderSide|isISOSweep|riskLimitSize|riskLimitReason|riskLimitDetail|nbboBid1|nbboAsk1|nbboBidSize1|nbboAskSize1|nbboBidCnt1|nbboAskCnt1|nbboBidMask1|nbboAskMask1|nbboBid2|nbboAsk2|nbboBidSize2|nbboAskSize2|nbboBidCnt2|nbboAskCnt2|nbboBidMask2|nbboAskMask2|netTimestamp|timestamp'

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

# 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 = 'engineName:eq:ExampleString'

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

# 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 = 'engineName:eq:ExampleString'

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