Skip to main content
Version: Upcoming

Schema: AltSymbolMap (ID: 1815)

METADATA​

AttributeValue
Topic1800-client-config
MLink TokenClientControl
SRSE ProductSRControl

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

BODY​

#FieldTypeDefault ValueComment
10=tickerTickerKey
13=srcAccntstring(16)client enter order in this account
12=clientFirmstring(16)SR assigned client firm acronym
100accntstring(16)this accnt will replace accnt on parent order (if exists)
103altAccntstring(16)will replace altAccnt on parent order (if exists)
106altUserNamestring(24)will replace altUserName on parent order (if exists)
109strategystring(36)will replace strategy on parent order (if exists)
112userData1text1will replace userData1 on parent order (if exists)
115userData2text1will replace userData2 on parent order (if exists)
118childDatatext1will replace childData on parent order (if exists)
157ticketLocateFirmstring(6)ticket/chat (default) locate firm
141stkExecBrkrCodestring(16)will replace execBrkrCode on stk parent orders (if exists)
142futExecBrkrCodestring(16)will replace execBrkrCode on fut parent orders (if exists)
143eqtOptExecBrkrCodestring(16)will replace execBrkrCode on eqt opt/mleg parent orders (if exists)
144futOptExecBrkrCodestring(16)will replace execBrkrCode on fut opt/mleg parent orders (if exists)
133modifiedBystring(24)user who last modified this record
136modifiedInenum : SysEnvironment
139timestampDateTimetimestamp of last modification

REPEATING FIELDS​

AltClearing

#FieldTypeDefault ValueComment
146execBrkrCodestring(16)
147exDeststring(16)exDest (eg. CBOEOPT, NMSOPT,NMSOPT, NMSSTK, CMX$FUT)
148clrFlipTypeenum : FlipTypetype of clearing corp delivery
149clrFlipFirmstring(6)deliverTo clearing member (eg. OCC#, NSCC#, MPID, or InstitutionID)
150clrFlipAccntstring(10)deliverTo client account (eg. OCC AID# or a DVP FBO code)
151clrAgentstring(10)deliverTo agent (eg. DVP Agent Bank ID)
152clrTaxIDstring(10)deliverTo taxID (eg. DVP TaxID)
159clrBrkrMPIDstring(8)
153execBrkrAccntstring(16)exec broker account (supplied by exec broker) (usually Account<1>) [only used if clrFlipType=BrkrAccnt]
154execBrkrClFirmstring(16)exec broker client/firm (supplied by exec broker) (usually OnBehalfOfCompId<115>) [only used if clrFlipType=BrkrAccnt]
155execBrkrUserNamestring(16)exec broker user name (supplied by exec broker)
156badgestring(16)exchange memembership and badge id

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

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

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

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

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

Post 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'

# Request Parameters
params = {
    # Required Parameters
    "apiKey": API_KEY,
    "cmd": 'postmsgs',
    "postaction": "I", # (I)nsert, (U)pdate, (R)eplace, or (D)elete
    "postmerge": "Y", # (Y)es or (N)o
}

payload = {
    "header": {
        "mTyp": "AltSymbolMap"
    },
    "message": {
        "pkey": {
            "ticker": {
                "at": "EQT",
                "ts": "NMS",
                "tk": "AAPL"
            },
            "srcAccnt": "exampleString", // string
            "clientFirm": "exampleString" // string
        },
        "accnt": "exampleString", // string
        "altAccnt": "exampleString", // string
        "altUserName": "exampleString", // string
        "strategy": "exampleString", // string
        "userData1": "exampleString", // text1
        "userData2": "exampleString", // text1
        "childData": "exampleString", // text1
        "ticketLocateFirm": "exampleString", // string
        "stkExecBrkrCode": "exampleString", // string
        "futExecBrkrCode": "exampleString", // string
        "eqtOptExecBrkrCode": "exampleString", // string
        "futOptExecBrkrCode": "exampleString", // string
        "modifiedBy": "exampleString", // string
        "modifiedIn": "enumValue", // enum(SysEnvironment) - None, Neptune, Pluto, V7_Stable, V7_Latest, Saturn, Venus, Mars, SysTest, V7_Current
        "timestamp": "2025-01-01 12:00:00.000000", // yyyy-MM-dd HH:mm:ss.SSSSSS
        "AltClearing": [ // Repeating Field
            {
                "execBrkrCode": "exampleString", // string
                "exDest": "exampleString", // string
                "clrFlipType": "enumValue", // enum(FlipType) - None, CMTA, Giveup, QSR, NSCC_Flip, DVP, BrkrAccnt
                "clrFlipFirm": "exampleString", // string
                "clrFlipAccnt": "exampleString", // string
                "clrAgent": "exampleString", // string
                "clrTaxID": "exampleString", // string
                "clrBrkrMPID": "exampleString", // string
                "execBrkrAccnt": "exampleString", // string
                "execBrkrClFirm": "exampleString", // string
                "execBrkrUserName": "exampleString", // string
                "badge": "exampleString" // string
            }
        ]
    }
}

response = requests.post(MLINK_PROD_URL, params=params, json=payload)