Version: 8.4.12.1

Schema: UserMetaData (ID: 3470)

METADATA

Attribute	Value
Topic	3325-mlink
MLink Token	MLinkRest

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

BODY

#	Field	Type	Comment
100	userName	string(24)	SR UserName Handle
103	clientFirm	string(16)
106	userType	enum : UserType
109	displayTimeZone	enum : SRTimeZone	[custom:UserTimeZone] User timezone (affects date/time display in Tools)
139	clientConfigAccess	enum : ConfigAccess	user can create new (pending approval) or edit existing client configuration records (SRAdmin, SponsorAdmin, ClientAdmin, or SRUser (any sysenv))
142	accountTypeControl	enum : AccountTypeControl
257	prodOrderAccess	enum : OrderAccess
258	testOrderAccess	enum : OrderAccess
259	canCancelProdOrders	enum : YesNo	user can cancel prod (live) orders (implied false for SRUsers, implied true for SRAdmin, SponsorAdmin, ClientAdmin, and users that can enter live orders)
260	canCancelTestOrders	enum : YesNo	user can cancel test orders (implied false for SRUsers, implied true for SRAdmin, SponsorAdmin, ClientAdmin, and users that can enter live orders)
261	canBookProdExecutions	enum : YesNo	user can enter prod (live) away tickets (default false for SRUsers SRAdmin, SponsorAdmin, and ClientAdmin, default true for users that can enter live orders)
262	canBookTestExecutions	enum : YesNo	user can enter test away tickets (default false for SRUsers, SRAdmin, SponsorAdmin, and ClientAdmin, default true for users that can enter live orders)
154	canEditMarRisk	enum : YesNo
160	canEditSupervisoryRisk	enum : YesNo
163	canEditStockLocateList	enum : YesNo
166	displayName	text1	[custom:UserDisplayName] User display name
169	contactEmail	text1	Contact Email Address (reset password email)
172	contactPhone	text1	Contact Phone Number (SMS Text #)
175	contactSlack	text1	Contact Slack Handle
178	contactIceChat	text1	Contact IceChat Handle
181	contactBBergHandle	text1	Contact Bloomberg Handle (BBGID)
184	authType	enum : AuthType	type of user logon allowed
187	defaultAccnt	string(16)	default account for this user (used as a tool default/setting); ignored if not viewable; if missing then default is the 1st accnt in the viewable list (alpha order)
190	altUserName	string(24)	alternate (client supplied) user name (usually for client system integration)
193	cmeTraderId	string(24)	CME assigned trader ID (if any)
196	cmeLocation	string(16)	For CME. The traders location is required. Format example: US,IL
199	cfeTraderId	string(24)	CFE assigned trader ID (if any)
202	cfeFrequentTraderId	string(24)	CFE frequent trader ID (if any)
205	cfeLocation	string(8)	CFE trader location (required)
208	iceTraderId	string(24)	ICE assigned trader ID (if any)
211	icePassword	string(24)	ICE assigned password (if any)
214	iceCompanyId	string(24)	ICE Company Id of trader (if any)
217	cboeTraderId	string(24)	Cboe assigned trader ID (if any)
220	badges	text1	exchange memembership and badge ids. CFEFUT:BADGE1,NYSESTK:BADGE2,...
268	hasApiKeyAccess	enum : YesNo	User is allowed to use and manage (insert, update and delete) API keys
256	timestamp	DateTime	timestamp of last modification

REPEATING FIELDS

AccountAccessControl

Field	Type	Comment
133	accnt	string(16)
136	accessType	enum : AccountAccessType

WebProductControl

Field	Type	Comment
226	token	enum : WebProductToken
229	expires	DateTime
232	value	string(10)

MLinkControl

Field	Type	Comment
238	token	enum : MLinkToken
241	expires	DateTime

MarketDataControl

Field	Type	Comment
247	token	enum : MarketDataToken
250	scope	enum : MarketDataScope
253	expires	DateTime

ApiKeys

Field	Type	Comment
264	id	byte
265	label	string(255)
266	expires	DateTime
267	created	DateTime

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

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

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

# 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 = 'userName|clientFirm|userType|displayTimeZone|clientConfigAccess|accountTypeControl|prodOrderAccess|testOrderAccess|canCancelProdOrders|canCancelTestOrders|canBookProdExecutions|canBookTestExecutions|canEditMarRisk|canEditSupervisoryRisk|canEditStockLocateList|displayName|contactEmail|contactPhone|contactSlack|contactIceChat|contactBBergHandle|authType|defaultAccnt|altUserName|cmeTraderId|cmeLocation|cfeTraderId|cfeFrequentTraderId|cfeLocation|iceTraderId|icePassword|iceCompanyId|cboeTraderId|badges|hasApiKeyAccess|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 = 'userName: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=UserMetaData' \
--data-urlencode 'view=userName|clientFirm|userType|displayTimeZone|clientConfigAccess|accountTypeControl|prodOrderAccess|testOrderAccess|canCancelProdOrders|canCancelTestOrders|canBookProdExecutions|canBookTestExecutions|canEditMarRisk|canEditSupervisoryRisk|canEditStockLocateList|displayName|contactEmail|contactPhone|contactSlack|contactIceChat|contactBBergHandle|authType|defaultAccnt|altUserName|cmeTraderId|cmeLocation|cfeTraderId|cfeFrequentTraderId|cfeLocation|iceTraderId|icePassword|iceCompanyId|cboeTraderId|badges|hasApiKeyAccess|timestamp' \
--data-urlencode 'where=userName: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 = 'UserMetaData'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'userName|clientFirm|userType|displayTimeZone|clientConfigAccess|accountTypeControl|prodOrderAccess|testOrderAccess|canCancelProdOrders|canCancelTestOrders|canBookProdExecutions|canBookTestExecutions|canEditMarRisk|canEditSupervisoryRisk|canEditStockLocateList|displayName|contactEmail|contactPhone|contactSlack|contactIceChat|contactBBergHandle|authType|defaultAccnt|altUserName|cmeTraderId|cmeLocation|cfeTraderId|cfeFrequentTraderId|cfeLocation|iceTraderId|icePassword|iceCompanyId|cboeTraderId|badges|hasApiKeyAccess|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 = 'userName: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 = 'userName: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=UserMetaData' \
--data-urlencode 'view=userName|clientFirm|userType|displayTimeZone|clientConfigAccess|accountTypeControl|prodOrderAccess|testOrderAccess|canCancelProdOrders|canCancelTestOrders|canBookProdExecutions|canBookTestExecutions|canEditMarRisk|canEditSupervisoryRisk|canEditStockLocateList|displayName|contactEmail|contactPhone|contactSlack|contactIceChat|contactBBergHandle|authType|defaultAccnt|altUserName|cmeTraderId|cmeLocation|cfeTraderId|cfeFrequentTraderId|cfeLocation|iceTraderId|icePassword|iceCompanyId|cboeTraderId|badges|hasApiKeyAccess|timestamp' \
--data-urlencode 'where=userName:eq:ExampleString' \
--data-urlencode 'limit=500' \
--data-urlencode 'order=userName: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 = 'UserMetaData'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'userName|clientFirm|userType|displayTimeZone|clientConfigAccess|accountTypeControl|prodOrderAccess|testOrderAccess|canCancelProdOrders|canCancelTestOrders|canBookProdExecutions|canBookTestExecutions|canEditMarRisk|canEditSupervisoryRisk|canEditStockLocateList|displayName|contactEmail|contactPhone|contactSlack|contactIceChat|contactBBergHandle|authType|defaultAccnt|altUserName|cmeTraderId|cmeLocation|cfeTraderId|cfeFrequentTraderId|cfeLocation|iceTraderId|icePassword|iceCompanyId|cboeTraderId|badges|hasApiKeyAccess|timestamp'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'userType|displayTimeZone|clientConfigAccess|accountTypeControl|prodOrderAccess|testOrderAccess|canCancelProdOrders|canCancelTestOrders|canBookProdExecutions|canBookTestExecutions|canEditMarRisk|canEditSupervisoryRisk|canEditStockLocateList|authType|hasApiKeyAccess'

# 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 = 'userName: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=UserMetaData' \
--data-urlencode 'measure=userName|clientFirm|userType|displayTimeZone|clientConfigAccess|accountTypeControl|prodOrderAccess|testOrderAccess|canCancelProdOrders|canCancelTestOrders|canBookProdExecutions|canBookTestExecutions|canEditMarRisk|canEditSupervisoryRisk|canEditStockLocateList|displayName|contactEmail|contactPhone|contactSlack|contactIceChat|contactBBergHandle|authType|defaultAccnt|altUserName|cmeTraderId|cmeLocation|cfeTraderId|cfeFrequentTraderId|cfeLocation|iceTraderId|icePassword|iceCompanyId|cboeTraderId|badges|hasApiKeyAccess|timestamp' \
--data-urlencode 'group=userType|displayTimeZone|clientConfigAccess|accountTypeControl|prodOrderAccess|testOrderAccess|canCancelProdOrders|canCancelTestOrders|canBookProdExecutions|canBookTestExecutions|canEditMarRisk|canEditSupervisoryRisk|canEditStockLocateList|authType|hasApiKeyAccess' \
--data-urlencode 'where=userName: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 = 'UserMetaData'

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

Schema: UserMetaData (ID: 3470)

METADATA​

BODY​

REPEATING FIELDS​

Get Schema API Call​

Get Msg API Call​

Get Msgs API Call​

Get Aggregate API Call​

Get Count API Call​

METADATA

BODY

REPEATING FIELDS

Get Schema API Call

Get Msg API Call

Get Msgs API Call

Get Aggregate API Call

Get Count API Call