Skip to main content
Version: Staging

Schema: ClientFirmConfig (ID: 1850)

METADATA​

AttributeValue
Topic1800-client-config
MLink TokenClientConfig

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

BODY​

#FieldTypeComment
10=clientFirmstring(16)SR assigned client firm acronym
100clientFirmStatusenum : ClientFirmStatusClientFirm status
103clientFirmStatusDttmDateTimeThe date/time this status was last changed
285enabledInenum : SysVersion
106clientFirmTypeenum : ClientFirmTypeSponsorClientFirm [Accnts/Users] -> CoreClientFirm [Accnts/Users] -> SubClientFirm [Accnts/Users]
109clientFirmNametext1SR assigned client firm Name
112clientFirmShortCodestring(4)SR assigned client firm short code (usually an MPID or equivalent)
115clientFirmRelationshipflag : ClientFirmRelationship
118repCodeSRtext1SR client rep code
121clientTagPooltext2(optional) complete (unique) pool of user defined account tag(s) (tag bag JSON definition block) [max of 10,000 total chars (including seps)]
124billingAccountstring(24)billing account within the G/L system
127billingSchedulestring(16)billing schedule code
130billingAddress1text1Billing Address - line 1
133billingAddress2text1Billing Address - line 2
136billingCitytext1Billing Address - city
139billingStatetext1Billing Address - state
142billingZipCodestring(8)Billing Address - zipCode
145billingCountrystring(8)Billing Address - country
148billingPhoneNumberstring(15)Billing - phone
151billingEmailAddresstext1Billing - emails (comma delimited string)
154reportAddress1text1Reporting Address - line 1
157reportAddress2text1Reporting Address - line 2
160reportCitytext1Reporting Address - city
163reportStatetext1Reporting Address - state
166reportZipCodestring(8)Reporting Address - zipCode
169reportCountrystring(8)Reporting Address - country
172reportPhoneNumberstring(15)Reporting - phone
175reportEmailAddresstext1Reporting - emails (comma delimited string)
178coreClientFirmstring(16)the core client firm this (Sub) client firm rolls up to [blank if none]
181sponsorClientFirmstring(16)the sponsor client firm this (Sub or Core) client firm rolls up to [blank if none]
184canHaveTradingAccntenum : YesNodisables all accnt activity
187legalEntityIdstring(20)(LEI) reg oversight committee assigned entity ID assigned to a firm. 20 character string, contains numbers and dashes.
190secLargeTraderIdstring(16)SEC-assigned trading ID assigned to a firm. 13 character string, contains numbers and dashes.
281LtidEffectiveDateDateTimeLargeTraderID Effective Date
282catCaisTidTypeenum : CatCaisTidTypeCAT CAIS TID (Transformed Identifiers) Type
283catCaisTidValuestring(40)CAT CAIS TID Value
284catCaisCustTypeenum : CatCaisCustTypeCAT CAIS CustomerType
193syncAggGroupstext1[tgt:src,tgt:src,...] target agg group [usually priAggGroup]; will accumulate SR executions; will sync w/srcAggGroup; tgt will follow (be made equal to) src
196syncThresholdfloatnumber of idle seconds before syncing aggGroups (default: 5 seconds)
199viewGICSenum : YesNoclient firm can see GICS codes in SRSE
202viewCUSIPenum : YesNoclient firm can see CUSIP codes in SRSE
205restrictLocateUploadenum : YesNorestrict all associated users' ability to upload AwayStockLocate messages
208restrictAutohedgeenum : YesNorestrict all associated users' ability to submit orders with autohedge enabled
211cxlRiskGroupOnReviewHedgeRejectenum : YesNobehavior if the stage/review hedge order is rejected. "Yes" cancels the entire risk group.
214userRateSourceenum : RateSourceDefault GlobalRate (Discount Rate) source (uses system default curve unless otherwise specified)
217enableSrseProductSnapshotsenum : YesNoIf enabled 'Yes' daily_snapshots.py scripts will make create clientFirm-specific snapshots of SRSE products. Grants are matched to UserConfig.SrseProductControl.
229authTypeenum : AuthTypetype of user logon allowed
232authExternNametext1eg. CorpName
235authExternParamstext1eg. https://corp.domain.com:xxxx
238pwFileTransferstring(16)[SR] Password for securing files in transit
241dropAllParentTagsenum : YesNo
271enableSrseProdenum : YesNoalso requires srse pool instance in schedule.txt (which advertises as SRSE-{SysRealm}-{RunStatus}-V8.services.consul...)
274modifiedBystring(24)user who last modified this record
277modifiedInenum : SysEnvironment
280timestampDateTime

REPEATING FIELDS​

LocatePool

FieldTypeComment
223locateFirmstring(6)
226locatePoolstring(16)

DirectedCounterParty

FieldTypeComment
247clientFirmstring(16)
250isCommPartyenum : YesNo

ExcludeCounterParty

FieldTypeComment
287clientFirmstring(16)

RawDataBilling

FieldTypeComment
256tokenenum : RawDataToken
259scopeenum : RawDataScope

SourceIP

FieldTypeComment
265ipV4Rangestring(20)
268ipV6Rangestring(50)

Get Schema API Call​

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

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

Get Msg API Call​

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

# 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 = 'clientFirmStatus|clientFirmStatusDttm|enabledIn|clientFirmType|clientFirmName|clientFirmShortCode|clientFirmRelationship|repCodeSR|clientTagPool|billingAccount|billingSchedule|billingAddress1|billingAddress2|billingCity|billingState|billingZipCode|billingCountry|billingPhoneNumber|billingEmailAddress|reportAddress1|reportAddress2|reportCity|reportState|reportZipCode|reportCountry|reportPhoneNumber|reportEmailAddress|coreClientFirm|sponsorClientFirm|canHaveTradingAccnt|legalEntityId|secLargeTraderId|LtidEffectiveDate|catCaisTidType|catCaisTidValue|catCaisCustType|syncAggGroups|syncThreshold|viewGICS|viewCUSIP|restrictLocateUpload|restrictAutohedge|cxlRiskGroupOnReviewHedgeReject|userRateSource|enableSrseProductSnapshots|authType|authExternName|authExternParams|pwFileTransfer|dropAllParentTags|enableSrseProd|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 = 'clientFirm: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)

Get Msgs API Call​

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

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'clientFirmStatus|clientFirmStatusDttm|enabledIn|clientFirmType|clientFirmName|clientFirmShortCode|clientFirmRelationship|repCodeSR|clientTagPool|billingAccount|billingSchedule|billingAddress1|billingAddress2|billingCity|billingState|billingZipCode|billingCountry|billingPhoneNumber|billingEmailAddress|reportAddress1|reportAddress2|reportCity|reportState|reportZipCode|reportCountry|reportPhoneNumber|reportEmailAddress|coreClientFirm|sponsorClientFirm|canHaveTradingAccnt|legalEntityId|secLargeTraderId|LtidEffectiveDate|catCaisTidType|catCaisTidValue|catCaisCustType|syncAggGroups|syncThreshold|viewGICS|viewCUSIP|restrictLocateUpload|restrictAutohedge|cxlRiskGroupOnReviewHedgeReject|userRateSource|enableSrseProductSnapshots|authType|authExternName|authExternParams|pwFileTransfer|dropAllParentTags|enableSrseProd|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 = 'clientFirm: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 = 'clientFirmStatus: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)

Get Aggregate API Call​

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

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'clientFirmStatus|clientFirmStatusDttm|enabledIn|clientFirmType|clientFirmName|clientFirmShortCode|clientFirmRelationship|repCodeSR|clientTagPool|billingAccount|billingSchedule|billingAddress1|billingAddress2|billingCity|billingState|billingZipCode|billingCountry|billingPhoneNumber|billingEmailAddress|reportAddress1|reportAddress2|reportCity|reportState|reportZipCode|reportCountry|reportPhoneNumber|reportEmailAddress|coreClientFirm|sponsorClientFirm|canHaveTradingAccnt|legalEntityId|secLargeTraderId|LtidEffectiveDate|catCaisTidType|catCaisTidValue|catCaisCustType|syncAggGroups|syncThreshold|viewGICS|viewCUSIP|restrictLocateUpload|restrictAutohedge|cxlRiskGroupOnReviewHedgeReject|userRateSource|enableSrseProductSnapshots|authType|authExternName|authExternParams|pwFileTransfer|dropAllParentTags|enableSrseProd|modifiedBy|modifiedIn|timestamp'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'clientFirmStatus|enabledIn|clientFirmType|canHaveTradingAccnt|catCaisTidType|catCaisCustType|viewGICS|viewCUSIP|restrictLocateUpload|restrictAutohedge|cxlRiskGroupOnReviewHedgeReject|userRateSource|enableSrseProductSnapshots|authType|dropAllParentTags|enableSrseProd|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 = 'clientFirm: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)

Get Count API Call​

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

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