Schema: AccountRouteConfig (ID: 1810)

METADATA

Attribute	Value
Topic	1800-client-config
MLink Token	ClientControl
SRSE Product	SRControl

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 assigned accnt code
14=	clientFirm	string(16)		SR assigned client firm acronym
15=	execBrkrCode	string(16)		SR execBrkrCode (SR Assigned)
100	enabled	enum : YesNo		yes=route enabled
103	relationship	enum : RelationshipType
106	catDestFirmIMID	string(16)		Destination Firm IMID (supplied by FINRA fbo destination; can be B/D or Exchange)
109	catDestDeptType	enum : CatDeptType		CAT destination department type
145	routingRule	enum : RoutingRule	RoundRobin
154	backupRouteCode	string(65)		backup route code (if above are unavailable)
166	externParams	text1		pass through params (must be understood by end point handler) usually [tag=value;tag=value;tag=value]
169	comment	text1		maintainer commments
172	modifiedBy	string(24)		user who last modified this record
175	modifiedIn	enum : SysEnvironment
178	timestamp	DateTime		timestamp of last modification

REPEATING FIELDS

ExecBrkrAccnts

#	Field	Type	Default Value	Comment
180	exchGroup	enum : ExchGroup		eg (NMS, CMX, ICE, EUREX) (NONE=ANY)
181	secType	enum : SpdrSecType		eg (Stock, Future, Option) (NONE=ANY)
182	execBrkrAccnt	string(16)		exec broker account (supplied by exec broker) (usually Account<1>)
183	execBrkrClFirm	string(16)		exec broker client/firm (supplied by exec broker) (usually OnBehalfOfCompId<115>)
184	execBrkrUserName	string(16)		exec broker user name (supplied by exec broker)

ClearingFlip

#	Field	Type	Default Value	Comment
193	exDest	string(16)		exDest (eg. CBOEOPT, NMS$OPT, NMS$STK, CMX$FUT)
187	clrFlipType	enum : FlipType		type of clearing corp delivery
188	clrFlipFirm	string(6)		deliverTo clearing member (eg. OCC#, NSCC#, MPID, or InstitutionID)
189	clrFlipAccnt	string(10)		deliverTo client account (eg. OCC AID# or a DVP FBO code)
190	clrAgent	string(10)		deliverTo agent (eg. DVP Agent Bank ID)
191	clrTaxID	string(10)		deliverTo taxID (eg. DVP TaxID)
196	clrBrkrMPID	string(8)		clearing broker (equity clearing only) [exDest is an option exch exDest=NMS$STK must exist in this list]

RoutingTable

#	Field	Type	Default Value	Comment
151	routingCode	string(65)		routing session code (is a RouteDefinition.pkey.routingCode) [RouteDefinition.execBrkrCode must match execBrkrCode]
197	featureDisable	flag : FeatureDisable		used to disable certain route features before reaching the routingCode/routeDefinition

ExchControl

#	Field	Type	Default Value	Comment
194	exDest	string(16)		exchange (eg. NYSESTK, CBOEOPT, NMS$OPT, NMS$STK, CMX$FUT) or custom (eg. INET$NIGHTHAWK)
163	disable	enum : YesNo

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

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

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

# 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 = 'enabled|relationship|catDestFirmIMID|catDestDeptType|routingRule|backupRouteCode|externParams|comment|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

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=AccountRouteConfig' \
--data-urlencode 'view=enabled|relationship|catDestFirmIMID|catDestDeptType|routingRule|backupRouteCode|externParams|comment|modifiedBy|modifiedIn|timestamp' \
--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 = 'AccountRouteConfig'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'enabled|relationship|catDestFirmIMID|catDestDeptType|routingRule|backupRouteCode|externParams|comment|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 = 'enabled: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=AccountRouteConfig' \
--data-urlencode 'view=enabled|relationship|catDestFirmIMID|catDestDeptType|routingRule|backupRouteCode|externParams|comment|modifiedBy|modifiedIn|timestamp' \
--data-urlencode 'where=accnt:eq:ExampleString' \
--data-urlencode 'limit=500' \
--data-urlencode 'order=enabled: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 = 'AccountRouteConfig'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'enabled|relationship|catDestFirmIMID|catDestDeptType|routingRule|backupRouteCode|externParams|comment|modifiedBy|modifiedIn|timestamp'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'enabled|relationship|catDestDeptType|routingRule|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

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=AccountRouteConfig' \
--data-urlencode 'measure=enabled|relationship|catDestFirmIMID|catDestDeptType|routingRule|backupRouteCode|externParams|comment|modifiedBy|modifiedIn|timestamp' \
--data-urlencode 'group=enabled|relationship|catDestDeptType|routingRule|modifiedIn' \
--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 = 'AccountRouteConfig'

# 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=AccountRouteConfig' \
--data-urlencode 'where=accnt:eq:ExampleString'