Skip to main content
Version: Upcoming

Schema: AccountConfig (ID: 1805)

METADATA​

AttributeValue
Topic1800-client-config
MLink TokenInternal
MLink EndpointMLink-Live
SRSE Product

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

BODY​

#FieldTypeDefault ValueComment
10=accntstring(16)
11=clientFirmstring(16)SR assigned client firm acronym
103accountTypeenum : AccountTypeSR account type (omnibus accounts are expected to be flat at the end of the day)
106accntStatusenum : AccntStatusThis accounts current status
109accntStatusDttmDateTimeThe Date/time this accounts status was changed
112accntNametext1account name
215omniAccntstring(25)associated omnibus account (if any) (must be type=Omnibus) [this account can do aggregated trading in omniAccnt]
216omniAccnt2string(25)associated omnibus account (if any) (must be type=Omnibus) [this account can do aggregated trading in omniAccnt2]
121tgtRollupAccntstring(16)target rollup account (must be type=Rollup) [this account rolls up into target account]
124tgtReconcileAccntSRstring(16)target reconciliation accnt (SR Side) (must be type=Reconcile) [this account aggregates into target reconcile account]
127tgtReconcileAccntCFstring(16)target reconciliation accnt (CLR Side) (must be type=Reconcile) [this account aggregates into target reconcile account]
130defaultTradingAccntstring(16)[our type=Rollup] default trading accnt (must be type=Trading) (if ticker not found in AltSymbolMap)
223mifidAccntIdstring(16)MIFID account identifier
133clientTagstext2(optional) user defined account tag(s) (eg. tag,tag,tag,tag) [max of 10,000 total chars (including seps)]
136proxyFirm1string(16)proxy firm #1
139proxyFirm2string(16)proxy firm #2
142proxyFirm3string(16)proxy firm #3
145billingSchedulestring(16)overrides billingSchedule at clientFirm level
220catFdidOpenDateDateKeyCAT FDID OpenDate
221catFdidEndDateDateKeyCAT FDID EndDate
166clientAccntstring(32)client assigned account string (optional) [used to map between client and SR configs]
169clientUserNamestring(32)client assigned account userName (optional) [usued to map between client and SR configs]
172clientAccntIdstext2comma separated list of alternate client defined accnt strings that all map to this accountConfig
175requireAltOrderIdenum : YesNoParent order must have an AltOrderId to proceed
178nbboFixDropMarkingenum : YesNoWhether or not to markup the FIX drop with nbbo information
181noCrossGroupstring(16)no cross grouping code (accounts with the same nCrossGroup will not cross with themselves) [default = ClientFirm]
225riskDropCFirmstring(16)EE automatically creates a duplicate copy of each execution in the awayDropCFirm/awayDropAccnt
226riskDropAccntstring(16)
184accntColorstring(16)citrix account color string
187symCtrlAccntstring(16)eg. SR.1 [default = accnt]
190theoModelstring(16)theo model (primary)
193theoModel2string(16)theo model #2
196hedgeDeltaRuleenum : HedgeDeltaRuleHedgeDelta Source (IVol = use SR implied surface (sticky strike), IvS = use SR surface (dynamic), TVol = use user supplied theo surface (sticky strike), TvS = use user supplied theo surface (dynamic)) [AccountConfig.hedgeDelta]
199binaryDaysfloatused to force delta calcs binary prior to expiration
202awayExecControlenum : AwayExecControlWhether to include Away Executions in EE risk counters
205riskGroupControlenum : RiskGroupControlenables enhanced risk group controls, ParentCap.n means each parent order can be at most 1/n of the risk group limit, StrictLimits implies PC.4
222isAtsEnabledenum : YesNo
224clrFlipEnabledenum : YesNoused to enable broker/dealers to send agency clearing (ClrFlip) instructions on parent orders
227pricingVersionenum : PricingVersion
208modifiedBystring(24)user who last modified this record
211modifiedInenum : SysEnvironment
214timestampDateTimetimestamp of last modification

REPEATING FIELDS​

RiskLevel

#FieldTypeDefault ValueComment
218riskLevelenum : MarRiskLevel
219customGroupstring(16)

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

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

# 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 = 'accountType|accntStatus|accntStatusDttm|accntName|omniAccnt|omniAccnt2|tgtRollupAccnt|tgtReconcileAccntSR|tgtReconcileAccntCF|defaultTradingAccnt|mifidAccntId|clientTags|proxyFirm1|proxyFirm2|proxyFirm3|billingSchedule|catFdidOpenDate|catFdidEndDate|clientAccnt|clientUserName|clientAccntIds|requireAltOrderId|nbboFixDropMarking|noCrossGroup|riskDropCFirm|riskDropAccnt|accntColor|symCtrlAccnt|theoModel|theoModel2|hedgeDeltaRule|binaryDays|awayExecControl|riskGroupControl|isAtsEnabled|clrFlipEnabled|pricingVersion|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)

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

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'accountType|accntStatus|accntStatusDttm|accntName|omniAccnt|omniAccnt2|tgtRollupAccnt|tgtReconcileAccntSR|tgtReconcileAccntCF|defaultTradingAccnt|mifidAccntId|clientTags|proxyFirm1|proxyFirm2|proxyFirm3|billingSchedule|catFdidOpenDate|catFdidEndDate|clientAccnt|clientUserName|clientAccntIds|requireAltOrderId|nbboFixDropMarking|noCrossGroup|riskDropCFirm|riskDropAccnt|accntColor|symCtrlAccnt|theoModel|theoModel2|hedgeDeltaRule|binaryDays|awayExecControl|riskGroupControl|isAtsEnabled|clrFlipEnabled|pricingVersion|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 = 'accountType: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 = 'AccountConfig'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'accountType|accntStatus|accntStatusDttm|accntName|omniAccnt|omniAccnt2|tgtRollupAccnt|tgtReconcileAccntSR|tgtReconcileAccntCF|defaultTradingAccnt|mifidAccntId|clientTags|proxyFirm1|proxyFirm2|proxyFirm3|billingSchedule|catFdidOpenDate|catFdidEndDate|clientAccnt|clientUserName|clientAccntIds|requireAltOrderId|nbboFixDropMarking|noCrossGroup|riskDropCFirm|riskDropAccnt|accntColor|symCtrlAccnt|theoModel|theoModel2|hedgeDeltaRule|binaryDays|awayExecControl|riskGroupControl|isAtsEnabled|clrFlipEnabled|pricingVersion|modifiedBy|modifiedIn|timestamp'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'accountType|accntStatus|requireAltOrderId|nbboFixDropMarking|hedgeDeltaRule|awayExecControl|riskGroupControl|isAtsEnabled|clrFlipEnabled|pricingVersion|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)

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

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