Skip to main content
Version: Upcoming

Schema: NoticeResponse (ID: 2470)

METADATA​

AttributeValue
Topic2450-liquidity-notice
MLink TokenSRATS
SRSE ProductSRTrade

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

BODY​

#FieldTypeComment
13=noticeNumberlong(required) AuctionNotice.noticeNumber
11=accntstring(16)(required) SR Accnt
12=clientFirmstring(16)(optional) SR ClientFirm
14=responseIdstring(24)(required) client ResponseId of this response; reflected back on NoticeExecReport messages
119tickerTickerKey(filled in on server) underlier ticker
120tradeDateDateKey(filled in on server)
101stageTypeenum : SpdrStageType(optional) (default is None/Live) can only be supplied on the initial notice response in a cancel/replace chain
102respSideenum : BuySell
103respSizeint
104respPricedouble
105refUPrcdouble
106refDefloat
107refGafloat
122deltaAdjenum : DeltaDirection(optional) Delta Adjusted Limit type. (None = Price Limit)
108minUBidfloat
109maxUAskfloat
110riskGroupIdlong(optional) any auction response is associated with this riskGroupID (and SpdrRiskGroupControl)
111strategystring(32)(optional) user strategy field (visible on SR tools)
112userData1text1(optional) user data field (free text) (reflected on NoticeResponse)
123locateFirmstring(6)
124locatePoolstring(16)
394autoHedgeenum : AutoHedge
397hedgeInstrumentenum : HedgeInst
400hedgeSecKeyExpiryKeyautohedge instrument (can be a TickerKey (stock) or ExpiryKey (future)) [required for Stock and Future]
403hedgeBetaRatiofloatportion of executed $money to auto-hedge (can be 1.0 / Beta for beta hedging) [-4.0 to +4.0]
406hedgeScopeenum : HedgeScopehedge group scope [RiskGroup or Accnt]
1034hedgeSessionenum : MarketSession
200modifiedBystring(24)
202modifiedInenum : SysEnvironment
204timestampDateTime

REPEATING FIELDS​

OrderLegs

FieldTypeComment
114secKeyOptionKey
115secTypeenum : SpdrKeyType
116sideenum : BuySell
117positionTypeenum : LegPositionType

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

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

# 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 = 'ticker|tradeDate|stageType|respSide|respSize|respPrice|refUPrc|refDe|refGa|deltaAdj|minUBid|maxUAsk|riskGroupId|strategy|userData1|locateFirm|locatePool|autoHedge|hedgeInstrument|hedgeSecKey|hedgeBetaRatio|hedgeScope|hedgeSession|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 = 'NoticeResponse'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'ticker|tradeDate|stageType|respSide|respSize|respPrice|refUPrc|refDe|refGa|deltaAdj|minUBid|maxUAsk|riskGroupId|strategy|userData1|locateFirm|locatePool|autoHedge|hedgeInstrument|hedgeSecKey|hedgeBetaRatio|hedgeScope|hedgeSession|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 = 'ticker: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 = 'NoticeResponse'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'ticker|tradeDate|stageType|respSide|respSize|respPrice|refUPrc|refDe|refGa|deltaAdj|minUBid|maxUAsk|riskGroupId|strategy|userData1|locateFirm|locatePool|autoHedge|hedgeInstrument|hedgeSecKey|hedgeBetaRatio|hedgeScope|hedgeSession|modifiedBy|modifiedIn|timestamp'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'stageType|respSide|deltaAdj|autoHedge|hedgeInstrument|hedgeScope|hedgeSession|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 = 'NoticeResponse'

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

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, or (R)eplace
    "postmerge": "Y", # (Y)es or (N)o
}

payload = {
    "header": {
        "mTyp": "NoticeResponse"
    },
    "message": {
        "pkey": {
            "noticeNumber": 1, // long
            "accnt": "exampleString", // string
            "clientFirm": "exampleString", // string
            "responseId": "exampleString" // string
        },
        "ticker": {
            "at": "EQT",
            "ts": "NMS",
            "tk": "AAPL"
        },
        "tradeDate": "2025-01-01", // yyyy-MM-dd
        "stageType": "enumValue", // enum(SpdrStageType) - None, ModifyAny, ModifyAlgo
        "respSide": "enumValue", // enum(BuySell) - None, Buy, Sell
        "respSize": 1, // int
        "respPrice": 1.0, // double
        "refUPrc": 1.0, // double
        "refDe": 1.0, // float
        "refGa": 1.0, // float
        "deltaAdj": "enumValue", // enum(DeltaDirection) - None, OneWay, TwoWay
        "minUBid": 1.0, // float
        "maxUAsk": 1.0, // float
        "riskGroupId": 1, // long
        "strategy": "exampleString", // string
        "userData1": "exampleString", // text1
        "locateFirm": "exampleString", // string
        "locatePool": "exampleString", // string
        "autoHedge": "enumValue", // enum(AutoHedge) - None, Static, AutoMid, AutoCrx, AutoTrn, SpdrAuto, Spdr10S, Spdr30S, Spdr90S, Spdr5M, Spdr30M, SpdrDay, SmartFast, SmartNorm, FastCrx, FastDark, SlowDark, AlphaVwap1pct, AlphaVwap2pct, AlphaVwap5pct, AlphaVwap25pct, Custom, AwayAlgo
        "hedgeInstrument": "enumValue", // enum(HedgeInst) - None, Default, FrontMonth, Stock, Future
        "hedgeSecKey": {
            "at": "EQT",
            "ts": "NMS",
            "tk": "AAPL",
            "dt": "2025-01-01"
        },
        "hedgeBetaRatio": 1.0, // float
        "hedgeScope": "enumValue", // enum(HedgeScope) - None, Accnt, RiskGroup
        "hedgeSession": "enumValue", // enum(MarketSession) - None, PreMkt, RegMkt, PostMkt, PreRegMkt, RegPostMkt, AllDay
        "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
        "OrderLegs": [ // Repeating Field
            {
                "secKey": {
                    "at": "EQT",
                    "ts": "NMS",
                    "tk": "AAPL",
                    "dt": "2025-01-01",
                    "xx": 1,
                    "cp": "Call"
                },
                "secType": "enumValue", // enum(SpdrKeyType) - None, Stock, Future, Option, MLeg
                "side": "enumValue", // enum(BuySell) - None, Buy, Sell
                "positionType": "enumValue" // enum(LegPositionType) - None, Auto, Open, Close, Long, Short, SellShort, Exempt, Cover
            }
        ]
    }
}

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