Schema: SpdrAwayExecution (ID: 1450)
SpdrAwayExecution records are published by ToolServers, SRSE, and FIX drop recv gateways. They are consumed by AwayExecutionMarkupServer which, in turn, publishes corresponding SpdrParentExecution records, including M1 and M10 updates.
METADATA
| Attribute | Value |
|---|---|
| Topic | 1450-away-drop |
| MLink Token | ClientTrading |
| SRSE Product | SRTrade |
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) | SR accnt | |
| 11= | clientFillId | long | client fill ID (should be unique for each accnt) | |
| 12= | clientFirm | string(16) | SR client firm | |
| 100 | fillNumber | long | SpiderRock execution number (globally unique over trailing 10 days) [copied in SpdrParentExecution.pkey.fillNumber] | |
| 200 | engineName | string(32) | ||
| 109 | spdrSource | enum : SpdrSource | SR source code | |
| 112 | execStatus | enum : ExecStatus | SR execution status (Fill,Bust,Correct,Reject) | |
| 115 | clientOrderId | string(24) | client order ID (should be unique for each clientFirm) (if any) [copied into SpdrParentExecution.altOrderId] | |
| 118 | srcRoutingCode | text1 | inbound FIX routing code (drop server) (if any) | |
| 121 | riskGroupId | long | 0 | riskGroupId (parent order group ID) for this away execution report (will be incorporated into a corresponding EE risk group counter if != 0) |
| 124 | secKey | OptionKey | SR security key | |
| 127 | secType | enum : SpdrKeyType | SR security type [Stock, Future, Option] | |
| 130 | execRole | enum : ExecRole | SpiderRock relationship to this execution record | |
| 133 | extExecBroker | string(12) | Client execBroker code | |
| 136 | fillSide | enum : BuySell | fill side | |
| 139 | fillPrice | double | fill price | |
| 142 | fillPriceType | enum : PriceType | Explicit | |
| 145 | fillQuantity | int | fill quantity | |
| 148 | childSize | int | child order size | |
| 151 | fillExch | string(6) | fill exchange (if any) | |
| 154 | fillDttm | DateTime | fill date/time | |
| 157 | fillRefUPrc | double | reference underlier price @ fill arrival time | |
| 160 | origExecID | text1 | original execution ID string (child order) | |
| 163 | lastExecID | text1 | most recent execution ID (same as origExecID unless CANCEL/CORRECTION has been processed) | |
| 166 | fillTransactDttm | DateTime | transaction date/time as reported by exchange or down stream broker | |
| 169 | fillReportDetail | text1 | extra detail (if any) from child execution | |
| 172 | ssaleFlag | enum : ShortSaleFlag | None | |
| 175 | positionType | enum : PositionType | None | |
| 178 | theoVol | float | 0 | client supplied theoretical volatility (used for markup only) |
| 181 | comment | text1 | text comment (if any) | |
| 184 | userData1 | text1 | client supplied data field; passes through to parent and child executions and reports as well as FIX drops | |
| 187 | userData2 | text1 | client supplied data field; passes through to parent and child executions and reports as well as FIX drops | |
| 190 | strategy | string(36) | client-supplied strategy string | |
| 193 | modifiedBy | string(24) | user who last modified this record | |
| 196 | modifiedIn | enum : SysEnvironment | ||
| 199 | timestamp | DateTime | timestamp of last modification |
Get Schema API Call
- Python
- cUrl
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 = 'SpdrAwayExecution'
# 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 -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getschema' \
--data-urlencode 'msgType=SpdrAwayExecution'
Get Msg API Call
- Python
- cUrl
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 = 'SpdrAwayExecution'
# 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 = 'fillNumber|engineName|spdrSource|execStatus|clientOrderId|srcRoutingCode|riskGroupId|secKey|secType|execRole|extExecBroker|fillSide|fillPrice|fillPriceType|fillQuantity|childSize|fillExch|fillDttm|fillRefUPrc|origExecID|lastExecID|fillTransactDttm|fillReportDetail|ssaleFlag|positionType|theoVol|comment|userData1|userData2|strategy|modifiedBy|modifiedIn|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 = '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 -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=SpdrAwayExecution' \
--data-urlencode 'view=fillNumber|engineName|spdrSource|execStatus|clientOrderId|srcRoutingCode|riskGroupId|secKey|secType|execRole|extExecBroker|fillSide|fillPrice|fillPriceType|fillQuantity|childSize|fillExch|fillDttm|fillRefUPrc|origExecID|lastExecID|fillTransactDttm|fillReportDetail|ssaleFlag|positionType|theoVol|comment|userData1|userData2|strategy|modifiedBy|modifiedIn|timestamp' \
--data-urlencode 'where=accnt:eq:ExampleString'
Get Msgs API Call
- Python
- cUrl
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 = 'SpdrAwayExecution'
# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'fillNumber|engineName|spdrSource|execStatus|clientOrderId|srcRoutingCode|riskGroupId|secKey|secType|execRole|extExecBroker|fillSide|fillPrice|fillPriceType|fillQuantity|childSize|fillExch|fillDttm|fillRefUPrc|origExecID|lastExecID|fillTransactDttm|fillReportDetail|ssaleFlag|positionType|theoVol|comment|userData1|userData2|strategy|modifiedBy|modifiedIn|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 = '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 = 'fillNumber: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 -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getmsgs' \
--data-urlencode 'msgType=SpdrAwayExecution' \
--data-urlencode 'view=fillNumber|engineName|spdrSource|execStatus|clientOrderId|srcRoutingCode|riskGroupId|secKey|secType|execRole|extExecBroker|fillSide|fillPrice|fillPriceType|fillQuantity|childSize|fillExch|fillDttm|fillRefUPrc|origExecID|lastExecID|fillTransactDttm|fillReportDetail|ssaleFlag|positionType|theoVol|comment|userData1|userData2|strategy|modifiedBy|modifiedIn|timestamp' \
--data-urlencode 'where=accnt:eq:ExampleString' \
--data-urlencode 'limit=500' \
--data-urlencode 'order=fillNumber:ASC'
Get Aggregate API Call
- Python
- cUrl
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 = 'SpdrAwayExecution'
# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'fillNumber|engineName|spdrSource|execStatus|clientOrderId|srcRoutingCode|riskGroupId|secKey|secType|execRole|extExecBroker|fillSide|fillPrice|fillPriceType|fillQuantity|childSize|fillExch|fillDttm|fillRefUPrc|origExecID|lastExecID|fillTransactDttm|fillReportDetail|ssaleFlag|positionType|theoVol|comment|userData1|userData2|strategy|modifiedBy|modifiedIn|timestamp'
# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'spdrSource|execStatus|secType|execRole|fillSide|fillPriceType|ssaleFlag|positionType|modifiedIn'
# 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 -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getaggregate' \
--data-urlencode 'msgType=SpdrAwayExecution' \
--data-urlencode 'measure=fillNumber|engineName|spdrSource|execStatus|clientOrderId|srcRoutingCode|riskGroupId|secKey|secType|execRole|extExecBroker|fillSide|fillPrice|fillPriceType|fillQuantity|childSize|fillExch|fillDttm|fillRefUPrc|origExecID|lastExecID|fillTransactDttm|fillReportDetail|ssaleFlag|positionType|theoVol|comment|userData1|userData2|strategy|modifiedBy|modifiedIn|timestamp' \
--data-urlencode 'group=spdrSource|execStatus|secType|execRole|fillSide|fillPriceType|ssaleFlag|positionType|modifiedIn' \
--data-urlencode 'where=accnt:eq:ExampleString'
Get Count API Call
- Python
- cUrl
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 = 'SpdrAwayExecution'
# 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 -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getcount' \
--data-urlencode 'msgType=SpdrAwayExecution' \
--data-urlencode 'where=accnt:eq:ExampleString'