Skip to main content
Version: 8.6.10.4

Schema: CorpActionDefinitionV3 (ID: 9148)

THE FUNDAMENTAL EVENT, once: a 3:2 split is ONE row here and thousands of KeyTransform edges. Machine-coded AND legal/textual. Carries the lifecycle - announced, REVISED, effective, cancelled - under a STABLE actionKey: revisions change terms, never identity (the occurrence-identity lesson)

METADATA​

AttributeValue
Topic9100-product-def-core
MLink TokenEquityDefinition
MLink EndpointMLink-Live
SRSE ProductSRReference

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

BODY​

#FieldTypeDefault ValueComment
10=actionKeystring(16)SR-minted, stable across revisions - 'CA26-004417'
100actionTypeenum : CorpActionTypeSplit / ReverseSplit / SpinOff / Merger / CashMerger / Exchange / Redemption / Call / Tender / RightsIssue / Novation / Succession / Rename / SeasoningMerge / Fork / IsinChange / CashDividend / ReturnOfCapital / Distribution / Rekey (a SpiderRock symbology change, no issuer event)
103kindenum : CorpActionKindScheduled / Announced - scheduled transits DERIVE their transforms (LINEAGE_MODEL 4.2); announced ones store them
106statusenum : CorpActionStatusAnnounced / Revised / Effective / Cancelled - the lifecycle
109subjectKeyTickerKeythe primary subject (the equity, the reference entity); the full blast radius is the transform edges; empty on a Rekey that moves many keys
112exDateDateKeyTHE TRANSIT BOUNDARY - transforms mint here, looking back
115effectiveTimeintms since midnight, venue tz - RECORDED here, APPLIED at the boundary (24x7 markets: the boundary is a convention we impose, LINEAGE_MODEL 4.4)
118announceDateDateKeydate the action was announced, which can be well before the effective date
121shareRatioNumint3:2 split -> 3 / 2
124shareRatioDenintdenominator of the share ratio - a 3:2 split is 3 over 2
127basisAllocPctdoubleNOT the share ratio (LINEAGE_MODEL 4.3) - basis follows relative fair values
130cashPerUnitdoubledividends, returns of capital, distributions, redemptions, cash mergers, cash-in-lieu
133electionTypeenum : ElectionTypeNone / CashOrStock / Tender / Exercise / Convert
136electionDeadlineDateKeylast date a holder may elect; empty where the action carries no election
139defaultElectionNotetext1what happens to a holder who does not elect
142legalTexttext2the documents' language - beside the codes, never instead of them
145eventSeriesKeystring(24)-> the MaterialEvent this action announced through
148sourceNotetext1vendor / filing citation
151pendingDeleteenum : YesNoYes = queued for removal; stop resolving against this row
900v3Sourceenum : V3SourceBridge = projected from a legacy record; Loader = written natively. None reads as Loader
154timestampDateTimewhen this row was last written
157oldIsinstring(12)the ISIN the subject carried before the action
160newIsinstring(12)the ISIN it carries after; empty where the ISIN does not change

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

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

# 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 = 'actionType|kind|status|subjectKey|exDate|effectiveTime|announceDate|shareRatioNum|shareRatioDen|basisAllocPct|cashPerUnit|electionType|electionDeadline|defaultElectionNote|legalText|eventSeriesKey|sourceNote|pendingDelete|v3Source|timestamp|oldIsin|newIsin'

# 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 = 'actionKey: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 = 'CorpActionDefinitionV3'

# Replace with your desired view. A "|" separated list of views can be provided
# If no view is provided, all views will be returned
VIEW = 'actionType|kind|status|subjectKey|exDate|effectiveTime|announceDate|shareRatioNum|shareRatioDen|basisAllocPct|cashPerUnit|electionType|electionDeadline|defaultElectionNote|legalText|eventSeriesKey|sourceNote|pendingDelete|v3Source|timestamp|oldIsin|newIsin'

# 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 = 'actionKey: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 = 'actionType: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 = 'CorpActionDefinitionV3'

# Replace with fields you want to see aggregate values for. A "|" separated list of measures should be provided
MEASURE = 'actionType|kind|status|subjectKey|exDate|effectiveTime|announceDate|shareRatioNum|shareRatioDen|basisAllocPct|cashPerUnit|electionType|electionDeadline|defaultElectionNote|legalText|eventSeriesKey|sourceNote|pendingDelete|v3Source|timestamp|oldIsin|newIsin'

# Replace with fields you want to see aggregated. A "|" separated list of fields should be provided
GROUP = 'actionType|kind|status|electionType|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 = 'actionKey: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 = 'CorpActionDefinitionV3'

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