Schema: AltSymbolMap (ID: 1815)

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	Comment
10=	ticker	TickerKey
13=	srcAccnt	string(16)	client enter order in this account
12=	clientFirm	string(16)	SR assigned client firm acronym
100	accnt	string(16)	this accnt will replace accnt on parent order (if exists)
103	altAccnt	string(16)	will replace altAccnt on parent order (if exists)
106	altUserName	string(24)	will replace altUserName on parent order (if exists)
109	strategy	string(36)	will replace strategy on parent order (if exists)
112	userData1	text1	will replace userData1 on parent order (if exists)
115	userData2	text1	will replace userData2 on parent order (if exists)
118	childData	text1	will replace childData on parent order (if exists)
121	ticketLocateFirm	string(6)	ticket/chat (default) locate firm
122	ticketLocatePool	string(16)	ticket/chat (default) locate pool/id @ firm granting the locate
141	stkExecBrkrCode	string(16)	will replace execBrkrCode on stk parent orders (if exists)
142	futExecBrkrCode	string(16)	will replace execBrkrCode on fut parent orders (if exists)
143	eqtOptExecBrkrCode	string(16)	will replace execBrkrCode on eqt opt/mleg parent orders (if exists)
144	futOptExecBrkrCode	string(16)	will replace execBrkrCode on fut opt/mleg parent orders (if exists)
133	modifiedBy	string(24)	user who last modified this record
136	modifiedIn	enum : SysEnvironment
139	timestamp	DateTime	timestamp of last modification

REPEATING FIELDS

AltClearing

Field	Type	Comment
146	execBrkrCode	string(16)
147	exDest	string(16)
148	clrFlipType	enum : FlipType
149	clrFlipFirm	string(6)
150	clrFlipAccnt	string(10)
151	clrAgent	string(10)
152	clrTaxID	string(10)
153	execBrkrAccnt	string(16)
154	execBrkrClFirm	string(16)
155	execBrkrUserName	string(16)
156	badge	string(16)

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

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

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

# 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 = 'accnt|altAccnt|altUserName|strategy|userData1|userData2|childData|ticketLocateFirm|ticketLocatePool|stkExecBrkrCode|futExecBrkrCode|eqtOptExecBrkrCode|futOptExecBrkrCode|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 = 'srcAccnt: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=AltSymbolMap' \
--data-urlencode 'view=accnt|altAccnt|altUserName|strategy|userData1|userData2|childData|ticketLocateFirm|ticketLocatePool|stkExecBrkrCode|futExecBrkrCode|eqtOptExecBrkrCode|futOptExecBrkrCode|modifiedBy|modifiedIn|timestamp' \
--data-urlencode 'where=srcAccnt: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 = 'AltSymbolMap'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'accnt|altAccnt|altUserName|strategy|userData1|userData2|childData|ticketLocateFirm|ticketLocatePool|stkExecBrkrCode|futExecBrkrCode|eqtOptExecBrkrCode|futOptExecBrkrCode|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 = 'srcAccnt: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 = 'accnt: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=AltSymbolMap' \
--data-urlencode 'view=accnt|altAccnt|altUserName|strategy|userData1|userData2|childData|ticketLocateFirm|ticketLocatePool|stkExecBrkrCode|futExecBrkrCode|eqtOptExecBrkrCode|futOptExecBrkrCode|modifiedBy|modifiedIn|timestamp' \
--data-urlencode 'where=srcAccnt:eq:ExampleString' \
--data-urlencode 'limit=500' \
--data-urlencode 'order=accnt: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 = 'AltSymbolMap'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'accnt|altAccnt|altUserName|strategy|userData1|userData2|childData|ticketLocateFirm|ticketLocatePool|stkExecBrkrCode|futExecBrkrCode|eqtOptExecBrkrCode|futOptExecBrkrCode|modifiedBy|modifiedIn|timestamp'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = '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 = 'srcAccnt: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=AltSymbolMap' \
--data-urlencode 'measure=accnt|altAccnt|altUserName|strategy|userData1|userData2|childData|ticketLocateFirm|ticketLocatePool|stkExecBrkrCode|futExecBrkrCode|eqtOptExecBrkrCode|futOptExecBrkrCode|modifiedBy|modifiedIn|timestamp' \
--data-urlencode 'group=modifiedIn' \
--data-urlencode 'where=srcAccnt: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 = 'AltSymbolMap'

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