Skip to main content
Version: 8.6.3.4

Schema: TickerDefinitionExt (ID: 4380)

TickerDefinitionExt (external) 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 TokenInternal
MLink EndpointMLink-Live
SRSE ProductSRLive, SRAnalytics

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

BODY​

#FieldTypeDefault ValueComment
10=tickerTickerKey
100symbolTypeenum : SymbolType
103namestring(72)Symbol name
106issuerNamestring(72)Name of issuer
109cntryOfIncorpstring(2)ISO Issuer Country Code
112parValuefloatSecurity Parvalue
115parValueCurrencystring(3)Security Parvalue currency
118pointValuefloat
121pointCurrencyenum : Currency
239priceFormatenum : PriceFormatPriceFormat: ex: NMS_Penny, NMS_HalfPenny
240minTickSizefloat
124primaryExchenum : PrimaryExchange
241altIDlongAlt Security ID number
130micstring(4)ISO Market Identification Code
133micSegstring(4)ISO Market Indentification Segment Code
136symbolstring(12)stock symbol
139issueClassstring(1)issue class of stock symbol. if no issue class field will be blank.
142securityIDintSecurity ID number from the source - Vendor, SR, Feed
145sicstring(4)SIC (Standard Industrial Classification) code
148cikstring(10)Central Index Key (US specific)
151gicsstring(8)Global Industry Classification Standard
154leistring(20)Legal Entity Identifier
157naicsstring(6)North American Industry Classification System
160cfistring(6)ISO Classification of Financial Instruments
163cicstring(4)Complementay Identification Code
166fisnstring(40)Financial Instrument Short Name
169isinstring(12)ISIN code
172bbgCompositeTickerstring(12)Bloomberg Composite Ticker
175bbgExchangeTickerstring(28)Bloomberg Exchange Ticker
178bbgCompositeGlobalIDstring(12)Bloomberg Composite Global ID
181bbgGlobalIDstring(12)Bloomberg Global ID
184bbgCurrencystring(3)Bloomberg Trading Currency
190stkVolumefloatdaily stock volume
193futVolumefloatdaily future volume
196optVolumefloatdaily option volume
199exchStringstring(8)exchanges listing any options on this underlying
202hasOptionsenum : YesNoHas Options flag
205numOptionsinttotal number of listed options
238roundlotintround lot
236sharesOutstandinglongsymbol shares outstanding, represented in thousands (actualsharesoutstanding = sharesoutstanding * 1000)
214otcPrimaryMarketenum : OTCPrimaryMarket
217otcTierenum : OTCTier
220otcReportingStatusstring(1)
223otcDisclosureStatusint
226otcFlagsint
229tkDefSourceenum : TkDefSourceTicker definition source: None; Vendor; OTC; SR; Exchange
232statusFlagenum : TkStatusFlag
211timeMetricenum : TimeMetrictrading time metric - 252 or 365 trading days or a weekly cycle type
237tradingPeriodenum : TradingPeriod
235timestampDateTime

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

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

# 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|name|issuerName|cntryOfIncorp|parValue|parValueCurrency|pointValue|pointCurrency|priceFormat|minTickSize|primaryExch|altID|mic|micSeg|symbol|issueClass|securityID|sic|cik|gics|lei|naics|cfi|cic|fisn|isin|bbgCompositeTicker|bbgExchangeTicker|bbgCompositeGlobalID|bbgGlobalID|bbgCurrency|stkVolume|futVolume|optVolume|exchString|hasOptions|numOptions|roundlot|sharesOutstanding|otcPrimaryMarket|otcTier|otcReportingStatus|otcDisclosureStatus|otcFlags|tkDefSource|statusFlag|timeMetric|tradingPeriod|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 = 'TickerDefinitionExt'

# 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|name|issuerName|cntryOfIncorp|parValue|parValueCurrency|pointValue|pointCurrency|priceFormat|minTickSize|primaryExch|altID|mic|micSeg|symbol|issueClass|securityID|sic|cik|gics|lei|naics|cfi|cic|fisn|isin|bbgCompositeTicker|bbgExchangeTicker|bbgCompositeGlobalID|bbgGlobalID|bbgCurrency|stkVolume|futVolume|optVolume|exchString|hasOptions|numOptions|roundlot|sharesOutstanding|otcPrimaryMarket|otcTier|otcReportingStatus|otcDisclosureStatus|otcFlags|tkDefSource|statusFlag|timeMetric|tradingPeriod|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 = '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)

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

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'symbolType|name|issuerName|cntryOfIncorp|parValue|parValueCurrency|pointValue|pointCurrency|priceFormat|minTickSize|primaryExch|altID|mic|micSeg|symbol|issueClass|securityID|sic|cik|gics|lei|naics|cfi|cic|fisn|isin|bbgCompositeTicker|bbgExchangeTicker|bbgCompositeGlobalID|bbgGlobalID|bbgCurrency|stkVolume|futVolume|optVolume|exchString|hasOptions|numOptions|roundlot|sharesOutstanding|otcPrimaryMarket|otcTier|otcReportingStatus|otcDisclosureStatus|otcFlags|tkDefSource|statusFlag|timeMetric|tradingPeriod|timestamp'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'symbolType|pointCurrency|priceFormat|primaryExch|hasOptions|otcPrimaryMarket|otcTier|tkDefSource|statusFlag|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 = 'TickerDefinitionExt'

# 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)