Skip to main content
Version: Upcoming

Schema: AuctionNoticeBX (ID: 2468)

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
10=noticeNumberlong
100tickerTickerKeyunderlier ticker
101tradeDateDateKey
102auctionTypeenum : AuctionType
103auctionEventenum : AuctionEvent
104srcAuctionIDstring(20)auction ID as known by the auction source (empty for SRC)
105srcAuctionTypestring(4)
106auctionSourceenum : AuctionSourcesource of the auction notice (eg. SRC, MIAX, etc.)
107isTestAuctionenum : YesNoif yes, auction is a test auction (not a prod/live auction)
108shortCodestring(8)8 letter auction short code (unique per day) (block auctions only) (can be used to find auctions on SR tools)
137industrytext1industry string
138symbolTypeenum : SymbolType
139uAvgDailyVlmfloatunderlier average daily trading volume
109rootTickerKeyoption root (+C.Lo/-P.Lo/-C.Hi/+P.Hi)
110expiryDateKey
111loStrikedoublelo strike
112hiStrikedoublehi strike
113custSideenum : BuySellif available
114custQtyint
115custPrcdoublepublic cust price
116hasCustPrcenum : YesNo
117custFirmTypeenum : FirmTypecust firm type (if disclosed)
118custAgentMPIDstring(6)cust agent exchange member initiating the auction (if disclosed)
119custClientFirmstring(16)cust client firm (if disclosed)
120commEnhancementfloatadditional commission (if any) paid by responder
121custCommPayingenum : YesNoclient is commission paying (to the responder)
122custQtyCondenum : CustQtyCondUpToQty, AllOrNone, QtyOrMore
123auctionDurationint[expected] auction duration (in milliseconds)
124iDaysdoubleiDays = effective interest days [SR supplied]
125iYearsdoubleiYears = iDays / 360.0
126pointValuedoublepoint value of the associated options; expiry money = (hiStrike - loStrike) * pointValue;
140pointCurrencyenum : Currency
127strikePvdoublestrikePv = strike * (1.0 - moneyRate * iYears) [moneyRate supplied above]
128effMoneyRatedoubleeffMoneyRate = (1.0 - (custPrc / (hiStrike - loStrike)) / iYears
129srcTimestamplong
130netTimestamplong
131timestampDateTimefrom ats / exchange net timestamp if possible
132includeSRNetworkenum : InclExclDisclose

REPEATING FIELDS​

DirectedCounterParty

FieldTypeComment
134clientFirmstring(16)
135inclExclenum : InclExclDisclose
136isCommPayingenum : YesNo

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

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

# 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|auctionType|auctionEvent|srcAuctionID|srcAuctionType|auctionSource|isTestAuction|shortCode|industry|symbolType|uAvgDailyVlm|root|expiry|loStrike|hiStrike|custSide|custQty|custPrc|hasCustPrc|custFirmType|custAgentMPID|custClientFirm|commEnhancement|custCommPaying|custQtyCond|auctionDuration|iDays|iYears|pointValue|pointCurrency|strikePv|effMoneyRate|srcTimestamp|netTimestamp|timestamp|includeSRNetwork'

# 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 = 'srcAuctionID: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 = 'AuctionNoticeBX'

# 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|auctionType|auctionEvent|srcAuctionID|srcAuctionType|auctionSource|isTestAuction|shortCode|industry|symbolType|uAvgDailyVlm|root|expiry|loStrike|hiStrike|custSide|custQty|custPrc|hasCustPrc|custFirmType|custAgentMPID|custClientFirm|commEnhancement|custCommPaying|custQtyCond|auctionDuration|iDays|iYears|pointValue|pointCurrency|strikePv|effMoneyRate|srcTimestamp|netTimestamp|timestamp|includeSRNetwork'

# 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 = 'srcAuctionID: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 = 'AuctionNoticeBX'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'ticker|tradeDate|auctionType|auctionEvent|srcAuctionID|srcAuctionType|auctionSource|isTestAuction|shortCode|industry|symbolType|uAvgDailyVlm|root|expiry|loStrike|hiStrike|custSide|custQty|custPrc|hasCustPrc|custFirmType|custAgentMPID|custClientFirm|commEnhancement|custCommPaying|custQtyCond|auctionDuration|iDays|iYears|pointValue|pointCurrency|strikePv|effMoneyRate|srcTimestamp|netTimestamp|timestamp|includeSRNetwork'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'auctionType|auctionEvent|auctionSource|isTestAuction|symbolType|custSide|hasCustPrc|custFirmType|custCommPaying|custQtyCond|pointCurrency|includeSRNetwork'

# 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 = 'srcAuctionID: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 = 'AuctionNoticeBX'

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