Skip to main content
Version: 8.4.12.1

Schema: TickerDefinition (ID: 4375)

TickerDefinition (internal only) records exist for all SpiderRock tickers including equity tickers (stocks and ETFs) as well as index tickers and synthetic tickers for future chains and option multihedge baskets.

METADATA​

AttributeValue
Topic4335-product-definition
MLink TokenEquityDefinition
SRSE ProductSRLive, SRAnalytics

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

BODY​

#FieldTypeComment
10=tickerTickerKey
100securityIDintSecurity ID number from the source - Vendor, SR, Feed
103symbolTypeenum : SymbolType
106namestring(72)Symbol name
109countrystring(2)ISO Issuer Country Code
254primaryCurrencyenum : Currency
255rateCurveenum : RateCurve
112parValuefloatSecurity Parvalue
115parValueCurrencystring(3)Security Parvalue currency
118pointValuefloat
121pointCurrencyenum : Currency
124primaryExchenum : PrimaryExchange
127altIDintAlt Security ID number
130micstring(4)ISO Market Identification Code
133micSegstring(4)ISO Market Indentification Segment Code
136symbolstring(12)trading symbol (w/o dot notation)
139issueClassstring(1)issue class of stock symbol. if no issue class field will be blank.
256sharesOutstandinglongsymbol shares outstanding, represented in thousands (actualsharesoutstanding = sharesoutstanding * 1000)
145cusipstring(10)cusip code
148indNumintIND (2 digits)
151subNumintSUB (4 digits)
154grpNumintGRP (6 digits)
157nbrNumintNBR (8 digits)
160sicstring(4)SIC (Standard Industrial Classification) code
163cikstring(10)Central Index Key (US specific)
166gicsstring(8)Global Industry Classification Standard
169leistring(20)Legal Entity Identifier
172naicsstring(6)North American Industry Classification System
175cfistring(6)ISO Classification of Financial Instruments
178cicstring(4)Complementay Identification Code
181fisnstring(40)Financial Instrument Short Name
184isinstring(12)ISIN code
187figistring(16)FIGI code
190bbgCompositeTickerstring(12)Bloomberg Composite Ticker
193bbgExchangeTickerstring(28)Bloomberg Exchange Ticker
196bbgCompositeGlobalIDstring(12)Bloomberg Composite Global ID
199bbgGlobalIDstring(12)Bloomberg Global ID
202bbgCurrencystring(3)Bloomberg Trading Currency
205otcPrimaryMarketenum : OTCPrimaryMarket
208otcTierenum : OTCTier
211otcReportingStatusstring(1)
214otcDisclosureStatusint
217otcFlagsint
220stkPriceIncenum : StkPriceIncPrice increment: None; FullPenny; Nickle
223tkDefSourceenum : TkDefSourceTicker definition source: None; Vendor; OTC; SR; Exchange
226statusFlagenum : TkStatusFlag
229tapeCodeenum : TapeCodeSIP Tape Code
232stkVolumefloatdaily stock volume
235futVolumefloatdaily future volume
238optVolumefloatdaily option volume
241exchStringstring(8)exchanges listing any options on this underlying
244hasOptionsenum : YesNoHas Options flag
247numOptionsinttotal number of listed options
257basisKeyTickerKeyskew basis fn key
258reverseSkewenum : YesNoif Yes/No, force skew curve norma/reverse (left/right) orientation, if None, auto-determine from data
250timeMetricenum : TimeMetrictrading time metric - 252 or 365 trading days or a weekly cycle type
259tradingPeriodenum : TradingPeriodtrading period code (defines 24-hour trading period start/stop)
263regionalCompositeTickerTickerKeyregional composite ticker - set on European contributor products only
253timestampDateTime

REPEATING FIELDS​

Exchange

FieldTypeComment
261stkExchenum : StkExch
262tickerTickerKey

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

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

# 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 = 'securityID|symbolType|name|country|primaryCurrency|rateCurve|parValue|parValueCurrency|pointValue|pointCurrency|primaryExch|altID|mic|micSeg|symbol|issueClass|sharesOutstanding|cusip|indNum|subNum|grpNum|nbrNum|sic|cik|gics|lei|naics|cfi|cic|fisn|isin|figi|bbgCompositeTicker|bbgExchangeTicker|bbgCompositeGlobalID|bbgGlobalID|bbgCurrency|otcPrimaryMarket|otcTier|otcReportingStatus|otcDisclosureStatus|otcFlags|stkPriceInc|tkDefSource|statusFlag|tapeCode|stkVolume|futVolume|optVolume|exchString|hasOptions|numOptions|basisKey|reverseSkew|timeMetric|tradingPeriod|regionalCompositeTicker|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 = 'name: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 = 'TickerDefinition'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'securityID|symbolType|name|country|primaryCurrency|rateCurve|parValue|parValueCurrency|pointValue|pointCurrency|primaryExch|altID|mic|micSeg|symbol|issueClass|sharesOutstanding|cusip|indNum|subNum|grpNum|nbrNum|sic|cik|gics|lei|naics|cfi|cic|fisn|isin|figi|bbgCompositeTicker|bbgExchangeTicker|bbgCompositeGlobalID|bbgGlobalID|bbgCurrency|otcPrimaryMarket|otcTier|otcReportingStatus|otcDisclosureStatus|otcFlags|stkPriceInc|tkDefSource|statusFlag|tapeCode|stkVolume|futVolume|optVolume|exchString|hasOptions|numOptions|basisKey|reverseSkew|timeMetric|tradingPeriod|regionalCompositeTicker|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 = 'name: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 = 'securityID: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 = 'TickerDefinition'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'securityID|symbolType|name|country|primaryCurrency|rateCurve|parValue|parValueCurrency|pointValue|pointCurrency|primaryExch|altID|mic|micSeg|symbol|issueClass|sharesOutstanding|cusip|indNum|subNum|grpNum|nbrNum|sic|cik|gics|lei|naics|cfi|cic|fisn|isin|figi|bbgCompositeTicker|bbgExchangeTicker|bbgCompositeGlobalID|bbgGlobalID|bbgCurrency|otcPrimaryMarket|otcTier|otcReportingStatus|otcDisclosureStatus|otcFlags|stkPriceInc|tkDefSource|statusFlag|tapeCode|stkVolume|futVolume|optVolume|exchString|hasOptions|numOptions|basisKey|reverseSkew|timeMetric|tradingPeriod|regionalCompositeTicker|timestamp'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'symbolType|primaryCurrency|rateCurve|pointCurrency|primaryExch|otcPrimaryMarket|otcTier|stkPriceInc|tkDefSource|statusFlag|tapeCode|hasOptions|reverseSkew|timeMetric|tradingPeriod'

# 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 = 'name: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 = 'TickerDefinition'

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