Schema: SpdrChildOrderSummary (ID: 2055)

SpdrChildOrderSummary records are created at the end of a trading period and contain a summary of trading activity for the period; Summary of SpdrChildOrder records

METADATA

Attribute	Value
Topic	2020-core
MLink Token	ClientChild
MLink Endpoint	MLink-Order
SRSE Product

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

BODY

#	Field	Type	Default Value	Comment
10=	accnt	string(16)
11=	secType	enum : SpdrKeyType
12=	tickerSrc	enum : TickerSrc
13=	spdrSource	enum : SpdrSource
14=	childShape	enum : SpdrOrderShape
15=	mktWidthCode	enum : MktWidthCode
16=	algoHandler	enum : ChildHandler
17=	routingCode	string(65)
22=	execBrkrCode	string(16)
23=	orderExDest	string(16)
20=	tradingPeriod	DateKey
21=	clientFirm	string(16)		SR client firm
103	numMarkets	int		number of unique secKeys
106	numChildOrders	int
109	sumChildOrderSize	int
112	sumChildMktWidth	float		mkt width at child order create time
115	sumActiveSeconds	float		total seconds child order is active (create to cancel/fill)
118	numMktPrints	int		number of comparable market prints (same series; same side; same day) [options only]
121	sumMktPrintM1PnL	float
124	sumMktPrintM10PnL	float
127	sumMarketableSize	int		size that would be expected to fill immediately when child order is generated
130	numOrderLatency	int
133	sumOrderLatency	float
136	numCancelLatency	int
139	sumCancelLatency	float
142	numFillAfterCxl	int
145	sumFill2CxlLatency	float
148	numContingentCxl	int
151	numChildOffMkt	int
154	numChildMktJoin	int
157	numChildMktImprv	int
160	numChildMarketable	int

Get Schema API Call

Python

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

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

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getschema' \
--data-urlencode 'msgType=SpdrChildOrderSummary'

Get Msg API Call

Python

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

# 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 = 'numMarkets|numChildOrders|sumChildOrderSize|sumChildMktWidth|sumActiveSeconds|numMktPrints|sumMktPrintM1PnL|sumMktPrintM10PnL|sumMarketableSize|numOrderLatency|sumOrderLatency|numCancelLatency|sumCancelLatency|numFillAfterCxl|sumFill2CxlLatency|numContingentCxl|numChildOffMkt|numChildMktJoin|numChildMktImprv|numChildMarketable'

# 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 = 'accnt: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)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getmsg' \
--data-urlencode 'pkey=ReplaceThisValueForTheQueryToWork' \
--data-urlencode 'msgType=SpdrChildOrderSummary' \
--data-urlencode 'view=numMarkets|numChildOrders|sumChildOrderSize|sumChildMktWidth|sumActiveSeconds|numMktPrints|sumMktPrintM1PnL|sumMktPrintM10PnL|sumMarketableSize|numOrderLatency|sumOrderLatency|numCancelLatency|sumCancelLatency|numFillAfterCxl|sumFill2CxlLatency|numContingentCxl|numChildOffMkt|numChildMktJoin|numChildMktImprv|numChildMarketable' \
--data-urlencode 'where=accnt:eq:ExampleString'

Get Msgs API Call

Python

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

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'numMarkets|numChildOrders|sumChildOrderSize|sumChildMktWidth|sumActiveSeconds|numMktPrints|sumMktPrintM1PnL|sumMktPrintM10PnL|sumMarketableSize|numOrderLatency|sumOrderLatency|numCancelLatency|sumCancelLatency|numFillAfterCxl|sumFill2CxlLatency|numContingentCxl|numChildOffMkt|numChildMktJoin|numChildMktImprv|numChildMarketable'

# 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 = 'accnt: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 = 'numMarkets: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)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getmsgs' \
--data-urlencode 'msgType=SpdrChildOrderSummary' \
--data-urlencode 'view=numMarkets|numChildOrders|sumChildOrderSize|sumChildMktWidth|sumActiveSeconds|numMktPrints|sumMktPrintM1PnL|sumMktPrintM10PnL|sumMarketableSize|numOrderLatency|sumOrderLatency|numCancelLatency|sumCancelLatency|numFillAfterCxl|sumFill2CxlLatency|numContingentCxl|numChildOffMkt|numChildMktJoin|numChildMktImprv|numChildMarketable' \
--data-urlencode 'where=accnt:eq:ExampleString' \
--data-urlencode 'limit=500' \
--data-urlencode 'order=numMarkets:ASC'

Get Aggregate API Call

Python

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

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'numMarkets|numChildOrders|sumChildOrderSize|sumChildMktWidth|sumActiveSeconds|numMktPrints|sumMktPrintM1PnL|sumMktPrintM10PnL|sumMarketableSize|numOrderLatency|sumOrderLatency|numCancelLatency|sumCancelLatency|numFillAfterCxl|sumFill2CxlLatency|numContingentCxl|numChildOffMkt|numChildMktJoin|numChildMktImprv|numChildMarketable'

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

# 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 = 'accnt: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)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getaggregate' \
--data-urlencode 'msgType=SpdrChildOrderSummary' \
--data-urlencode 'measure=numMarkets|numChildOrders|sumChildOrderSize|sumChildMktWidth|sumActiveSeconds|numMktPrints|sumMktPrintM1PnL|sumMktPrintM10PnL|sumMarketableSize|numOrderLatency|sumOrderLatency|numCancelLatency|sumCancelLatency|numFillAfterCxl|sumFill2CxlLatency|numContingentCxl|numChildOffMkt|numChildMktJoin|numChildMktImprv|numChildMarketable' \
--data-urlencode 'group=' \
--data-urlencode 'where=accnt:eq:ExampleString'

Get Count API Call

Python

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

# 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 = 'accnt: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)

cUrl

curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getcount' \
--data-urlencode 'msgType=SpdrChildOrderSummary' \
--data-urlencode 'where=accnt:eq:ExampleString'