Schema: TickerKeyDefinitionV3 (ID: 9100)

One row per (TickerKey, tickerClass) - the join spine at the ticker rung. Holds only what is true

of EVERY TickerKey; kind-specific facts live on satellites (RootDefinitionV3, CCodeDefinitionV3,

BondIssueDefinitionV3, ObligorDefinitionV3 ...).

TickerDefinition (4375) and TickerDefinitionExt (4380) are computed PROJECTIONS of this record.

REGISTRY IDENTIFIERS ARE NOT HERE. isin, cusip, figi, lei and the Bloomberg codes ride

ProductMappingV3 (9127); the 4375 projection reads them back out of it.

WHICH KEYS GET A ROW is decided by pkey shape:

TickerKey-pkeyed -> a row here, one per role the key plays

ExpiryKey-pkeyed -> a deeper rung (Future, OptionExpiry) - no row

OptionKey-pkeyed -> a leaf (Option, Bond, Pool, Tranche) - no row

Futures ccodes and option roots are ticker-rung and DO get rows; the contracts and bonds beneath

them do not.

METADATA

Attribute	Value
Topic	9100-product-def-core
MLink Token	EquityDefinition
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=	ticker	TickerKey		asset type and ticker source are IN the key - no separate fields
11=	tickerClass	enum : TickerClass
100	symbolType	enum : SymbolType		the sole navigation classifier; read this one column, no other casing
148	cfi	string(6)		ISO 10962; the finer kind derives from it where symbolType stops
151	cic	string(4)		Complementary Identification Code
103	symbol	string(12)		trading symbol, no dot notation
106	name	string(72)
109	country	string(2)		ISO issuer country
112	primaryCurrency	string(3)
115	parentTicker	TickerKey		cross-source is fine - it is just a key
118	regionalCompositeTicker	TickerKey		listing-rung up-link: a VenueListing row's line, the key VenueListingDefinitionV3 (9139) quoteKey names; distinct from parentTicker
121	displaySecKey	OptionKey
124	displaySecType	enum : SpdrKeyType
127	displayMeaningNote	text1		what the designated quote is taken to represent
130	displayRationaleNote	text1		why this one was chosen
133	tkDefSource	enum : TkDefSource		None / Vendor / OTC / SR / Exchange
136	statusFlag	enum : TkStatusFlag		None / Active / Delisted
139	pendingDelete	enum : YesNo
142	sourceNote	text1
900	v3Source	enum : V3Source
145	timestamp	DateTime

Get Schema API Call

Python

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

# 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

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

Get Msg API Call

Python

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

# 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 = 'symbolType|cfi|cic|symbol|name|country|primaryCurrency|parentTicker|regionalCompositeTicker|displaySecKey|displaySecType|displayMeaningNote|displayRationaleNote|tkDefSource|statusFlag|pendingDelete|sourceNote|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 = 'cfi: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)

cUrl

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=TickerKeyDefinitionV3' \
--data-urlencode 'view=symbolType|cfi|cic|symbol|name|country|primaryCurrency|parentTicker|regionalCompositeTicker|displaySecKey|displaySecType|displayMeaningNote|displayRationaleNote|tkDefSource|statusFlag|pendingDelete|sourceNote|v3Source|timestamp' \
--data-urlencode 'where=cfi:eq:ExampleString'

Get Msgs API Call

Python

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

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'symbolType|cfi|cic|symbol|name|country|primaryCurrency|parentTicker|regionalCompositeTicker|displaySecKey|displaySecType|displayMeaningNote|displayRationaleNote|tkDefSource|statusFlag|pendingDelete|sourceNote|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 = 'cfi: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 = 'symbolType: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

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=TickerKeyDefinitionV3' \
--data-urlencode 'view=symbolType|cfi|cic|symbol|name|country|primaryCurrency|parentTicker|regionalCompositeTicker|displaySecKey|displaySecType|displayMeaningNote|displayRationaleNote|tkDefSource|statusFlag|pendingDelete|sourceNote|v3Source|timestamp' \
--data-urlencode 'where=cfi:eq:ExampleString' \
--data-urlencode 'limit=500' \
--data-urlencode 'order=symbolType:ASC'

Get Aggregate API Call

Python

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

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'symbolType|cfi|cic|symbol|name|country|primaryCurrency|parentTicker|regionalCompositeTicker|displaySecKey|displaySecType|displayMeaningNote|displayRationaleNote|tkDefSource|statusFlag|pendingDelete|sourceNote|v3Source|timestamp'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'symbolType|displaySecType|tkDefSource|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 = 'cfi: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)

cUrl

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=TickerKeyDefinitionV3' \
--data-urlencode 'measure=symbolType|cfi|cic|symbol|name|country|primaryCurrency|parentTicker|regionalCompositeTicker|displaySecKey|displaySecType|displayMeaningNote|displayRationaleNote|tkDefSource|statusFlag|pendingDelete|sourceNote|v3Source|timestamp' \
--data-urlencode 'group=symbolType|displaySecType|tkDefSource|statusFlag|pendingDelete|v3Source' \
--data-urlencode 'where=cfi:eq:ExampleString'

Get Count API Call

Python

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

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

cUrl

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=TickerKeyDefinitionV3' \
--data-urlencode 'where=cfi:eq:ExampleString'