Schema: HolidayCalendarV3 (ID: 9012)
The holiday calendar of record: one calendar's content - its weekend, the variance-time shape of its trading day
and its dated exceptions - keyed by that content.
THE KEY IS THE CONTENT. calendarKey is a ContentKey tagged Calendar over the SHA-256 of the canonical form (CALENDAR_CONTENT_KEY.md),
byte 0 dropped for the tag. A loader hashes what it built and publishes; two producers building
the same calendar publish the same row, and nobody mints an id. A row is immutable: a changed calendar is a
new row under a new key, and a deleted row is content withdrawn.
THE NAME LIVES ELSEWHERE. ScheduleDefinitionV3 (9057) points a product group at a key and carries the
Manual / Loader / Bridge ladder; CalendarDefinitionV3 (9009) is the human registry of adopted names (XCME,
USNY) pointing at their current key. The compiled tables are the floor beneath both and keep their names.
desc is the producer's memo - 'union of XAMS, XEUR', 'XCME 2026 refresh' - readability, never identity.
METADATA
| Attribute | Value |
|---|---|
| Topic | 9000-product-def-authority |
| MLink Token | ClientLive |
| MLink Endpoint | MLink-Live |
| SRSE Product | SRReference |
Note: The symbol
=next to a field number indicates that it is a primary key.
BODY
| # | Field | Type | Default Value | Comment |
|---|---|---|---|---|
| 10= | calendarKey | ContentKey | content key: Calendar tag + 15 bytes of the SHA-256 of the canonical form (CALENDAR_CONTENT_KEY.md) | |
| 100 | timestamp | DateTime | ||
| 101 | desc | text1 | the producer's memo: what this content is | |
| 102 | weekendMask | byte | bit per weekday (bit0=Mon); 0x60 = Sat+Sun; part of the key | |
| 900 | v3Source | enum : V3Source | who published this content; provenance, never precedence | |
| 110 | vtRatio | double | [0 - 1] proportion of variance that occurs during market hours (D252) | |
| 111 | mktVTimeOpen | TimeSpan | vTime market open time (in sysRegion timezone) | |
| 112 | mktVTimeClose | TimeSpan | vTime market close time (in sysRegion timezone) | |
| 113 | mktVTimeEarlyCls | TimeSpan | vTime market early close time (in sysRegion timezone) |
REPEATING FIELDS
Holiday
| # | Field | Type | Default Value | Comment |
|---|---|---|---|---|
| 115 | date | DateKey | ||
| 116 | marketDayType | enum : MarketDayType | Regular, Modified, MarketClosed | |
| 117 | settleDayType | enum : SettleDayType | SettlementOpen or SettlementClosed |
Get Schema API Call
- Python
- cUrl
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 = 'HolidayCalendarV3'
# 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)
curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getschema' \
--data-urlencode 'msgType=HolidayCalendarV3'
Get Msg API Call
- Python
- cUrl
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 = 'HolidayCalendarV3'
# 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 = 'timestamp|desc|weekendMask|v3Source|vtRatio|mktVTimeOpen|mktVTimeClose|mktVTimeEarlyCls'
# 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 = ''
# 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)
curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getmsg' \
--data-urlencode 'pkey=ReplaceThisValueForTheQueryToWork' \
--data-urlencode 'msgType=HolidayCalendarV3' \
--data-urlencode 'view=timestamp|desc|weekendMask|v3Source|vtRatio|mktVTimeOpen|mktVTimeClose|mktVTimeEarlyCls' \
--data-urlencode 'where='
Get Msgs API Call
- Python
- cUrl
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 = 'HolidayCalendarV3'
# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'timestamp|desc|weekendMask|v3Source|vtRatio|mktVTimeOpen|mktVTimeClose|mktVTimeEarlyCls'
# 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 = ''
# 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 = 'timestamp: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)
curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getmsgs' \
--data-urlencode 'msgType=HolidayCalendarV3' \
--data-urlencode 'view=timestamp|desc|weekendMask|v3Source|vtRatio|mktVTimeOpen|mktVTimeClose|mktVTimeEarlyCls' \
--data-urlencode 'where=' \
--data-urlencode 'limit=500' \
--data-urlencode 'order=timestamp:ASC'
Get Aggregate API Call
- Python
- cUrl
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 = 'HolidayCalendarV3'
# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'timestamp|desc|weekendMask|v3Source|vtRatio|mktVTimeOpen|mktVTimeClose|mktVTimeEarlyCls'
# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'v3Source'
# 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 = ''
# 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)
curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getaggregate' \
--data-urlencode 'msgType=HolidayCalendarV3' \
--data-urlencode 'measure=timestamp|desc|weekendMask|v3Source|vtRatio|mktVTimeOpen|mktVTimeClose|mktVTimeEarlyCls' \
--data-urlencode 'group=v3Source' \
--data-urlencode 'where='
Get Count API Call
- Python
- cUrl
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 = 'HolidayCalendarV3'
# 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 = ''
# 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)
curl -G 'https://mlink-live.nms.saturn.spiderrockconnect.com/rest/json' \
--data-urlencode 'apiKey=XXXX-XXXX-XXXX-XXXX' \
--data-urlencode 'cmd=getcount' \
--data-urlencode 'msgType=HolidayCalendarV3' \
--data-urlencode 'where='