Skip to main content
Version: 8.6.10.4

Schema: MaterialEventSeriesV3 (ID: 9042)

one record per recurring series of date/time-definite repricing events: bank meetings, gov reports, inventory numbers, auctions, earnings, production policy

METADATA​

AttributeValue
Topic9000-product-def-authority
MLink TokenClientLive
MLink EndpointMLink-Live
SRSE ProductSRReference

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

BODY​

#FieldTypeDefault ValueComment
10=seriesKeystring(24)'FOMC', 'US-CPI', 'WASDE', 'UST-AUCTION', 'EARN:AAPL' [LITE] eventDefs.ts seriesKey
100namestring(40)'FOMC decision', 'EIA petroleum status' [LITE] eventDefs.ts name
103categoryenum : MaterialEventCategoryCentralBank / GovtReport / InventoryReport / Auction / Earnings / CorpAction / ProductionPolicy / Expiry / MarketHoliday / Symbology
106sourceNamestring(40)'Federal Reserve', 'BLS', 'USDA', 'US Treasury', the company [LITE] eventDefs.ts source
109sourceObligorKeyTickerKeyAT = ENT when the source is a keyed entity; empty otherwise
112isMacroenum : YesNoFOMC, CPI, NFP - reprices everything [LITE] eventDefs.ts scope.macro
115subjectTickerTickerKeythe key the series is ABOUT, when it has one; empty for report series
118cadenceNotetext1the rule in words - '8 meetings/yr', 'weekly Wed 10:30' [LITE] eventDefs.ts cadence
121cadenceRulestring(64)machine recurrence (RRULE-shaped) - the forecast projector's input; empty = authored occurrences only
124timeZoneenum : SRTimeZone-> TimeZoneDefinition; the zone occurrence times quote in [LITE] eventDefs.ts tzName
127statusFlagenum : TkStatusFlagActive or Delisted. A delisted row stays resolvable and is never deleted
130pendingDeleteenum : YesNoYes = queued for removal; stop resolving against this row
133meaningNotetext1free-text note on what this row means
136rationaleNotetext1why this row is shaped as it is, where that is a house reading rather than a market fact
900v3Sourceenum : V3SourceBridge = projected from a legacy record; Loader = written natively. None reads as Loader
139timestampDateTimewhen this row was last written

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

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

# 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 = 'name|category|sourceName|sourceObligorKey|isMacro|subjectTicker|cadenceNote|cadenceRule|timeZone|statusFlag|pendingDelete|meaningNote|rationaleNote|v3Source|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 = 'seriesKey: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 = 'MaterialEventSeriesV3'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'name|category|sourceName|sourceObligorKey|isMacro|subjectTicker|cadenceNote|cadenceRule|timeZone|statusFlag|pendingDelete|meaningNote|rationaleNote|v3Source|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 = 'seriesKey: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 = 'name: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 = 'MaterialEventSeriesV3'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'name|category|sourceName|sourceObligorKey|isMacro|subjectTicker|cadenceNote|cadenceRule|timeZone|statusFlag|pendingDelete|meaningNote|rationaleNote|v3Source|timestamp'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'category|isMacro|timeZone|statusFlag|pendingDelete|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 = 'seriesKey: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 = 'MaterialEventSeriesV3'

# 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 = 'seriesKey: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)
Table of Contents