6.1 - Data Dictionary¶
GET https://api.infotrie.com/api/market_data/get_corporate_actions, with your InfoTrie API key in the X-API-Key header (a console key needs the market_data scope), returns nine lists, one per kind of corporate action, over a date window. Dates are yyyy-MM-dd.
start_date,end_date: the window, inclusive. With both, exactly that range. Otherwiseend_datedefaults to yesterday (UTC) andstart_datetoend_dateminusndays - 1; the response echoes the effectivestart_dateandend_date.ndays: the window length when a bound is missing, 1 to 3650, default 7.event_type: one list only, by its name below (any case); the other lists come back empty. Any other value is a400.country: only the records of that country, an exact match on the listing's country name, applied to every list. Dividend records carry nocountryfield; the filter still applies to them, on their listing's country. A record whosecountryis null never matches.
Each list is ordered by effective date, then symbol. There is no limit and no paging: a wide window returns everything in it.
Source¶
Each record comes from InfoTrie's corporate-action golden copy: one record per instrument, action, effective date and class of security, taken from the best-ranked source allowed on the API. Every item's source field is that source's public label.
Today the only source is SEC EDGAR, for US issuers: listings (Form 8-A12B), delistings (Forms 25-NSE and 25), bankruptcies, completed acquisitions and delisting notices (Form 8-K items 1.03, 2.01 and 3.01), and name changes. A delisting's effective date is the earliest the rule allows, the filing date plus 10 days. The splits, dividends and spinoffs lists, and symbol changes in changes, come back empty until a source that carries them is connected.
Identity¶
company_id, symbol, company_name and country (and a dividend's exchange_code) are those of the instrument's most recently priced listing. For an instrument not priced in the last 14 days (a delisting a few weeks old, for instance), symbol and exchange_code come from the listing history (the listing valid on the effective date, else the latest one) and company_id from the InfoTrie company its ISIN maps to on that date; company_name and country are then null. All of them are null for an instrument the listing history does not hold.
The nine lists¶
| # | List | Corporate action |
|---|---|---|
| 1 | changes |
A change of company name or symbol. |
| 2 | listed |
A new listing on an exchange. |
| 3 | delisted |
A removal from an exchange. |
| 4 | spinoffs |
Part of a company spun off as a new company. |
| 5 | splits |
A stock split or reverse split. |
| 6 | bankruptcies |
A bankruptcy filing. |
| 7 | acquisitions |
A completed acquisition of the company. |
| 8 | dividends |
A dividend: its ex-date, declaration date, amount and currency. |
| 9 | delisting_notices |
A notice that a company fails a listing rule (Form 8-K item 3.01). Not a delisting: the delisting, if it comes, is in delisted. |
Fields¶
Apart from date_effective, any field may be null when the source does not give it. A field marked null is one the golden copy does not carry: it is always null.
| List | Field | Type | Description |
|---|---|---|---|
changes |
date_effective |
string | The date the action takes effect. The window filters on it. |
changes |
company_id |
integer | InfoTrie's identifier of the company. |
changes |
change_type |
string | name_change or symbol_change. |
changes |
old_symbol |
string | The ticker before the change; for a name change, the listing's current ticker. |
changes |
old_company_name |
string | The name before the change; for a symbol change, the listing's current name. |
changes |
new_symbol |
string | The ticker after the change; for a name change, the listing's current ticker. |
changes |
new_company_name |
string | The name after the change; for a symbol change, the listing's current name. |
changes |
country |
string | The company's country; what the country parameter matches. |
changes |
date_announced |
string | The date the action was made public. |
changes |
source |
string | The public label of the source. |
listed |
date_effective |
string | The date the action takes effect. The window filters on it. |
listed |
company_id |
integer | InfoTrie's identifier of the company. |
listed |
company_name |
string | The company's name. |
listed |
symbol |
string | The company's ticker. |
listed |
security_class |
string | The class of security concerned, as the filing names it (common stock, notes, warrants). |
listed |
country |
string | The company's country; what the country parameter matches. |
listed |
date_announced |
string | The date the action was made public. |
listed |
source |
string | The public label of the source. |
delisted |
date_effective |
string | The date the action takes effect. The window filters on it. |
delisted |
company_id |
integer | InfoTrie's identifier of the company. |
delisted |
company_name |
string | The company's name. |
delisted |
symbol |
string | The company's ticker. |
delisted |
security_class |
string | The class of security concerned, as the filing names it. A delisting may concern notes or warrants rather than the stock. |
delisted |
country |
string | The company's country; what the country parameter matches. |
delisted |
date_announced |
string | The date the action was made public. |
delisted |
source |
string | The public label of the source. |
spinoffs |
date_effective |
string | The date the action takes effect. The window filters on it. |
spinoffs |
parent_company_id |
integer | InfoTrie's identifier of the parent company. |
spinoffs |
parent_company_name |
string | The parent company's name. |
spinoffs |
parent_symbol |
string | The parent company's ticker. |
spinoffs |
new_company_id |
integer | null. |
spinoffs |
new_company_name |
string | The new company's name. |
spinoffs |
new_symbol |
string | null. |
spinoffs |
country |
string | The parent company's country; what the country parameter matches. |
spinoffs |
date_announced |
string | The date the action was made public. |
spinoffs |
source |
string | The public label of the source. |
splits |
date_effective |
string | The ex-date. The window filters on it. |
splits |
company_id |
integer | InfoTrie's identifier of the company. |
splits |
symbol |
string | The company's ticker. |
splits |
company_name |
string | The company's name. |
splits |
split_type |
string | forward (more shares after the split) or reverse (fewer). |
splits |
split_ratio |
string | New shares to old shares, new:old: 2:1 is a two-for-one split, 1:10 a one-for-ten reverse split. |
splits |
country |
string | The company's country; what the country parameter matches. |
splits |
date_announced |
string | The date the action was made public. |
splits |
source |
string | The public label of the source. |
bankruptcies |
date_effective |
string | The date the action takes effect. The window filters on it. |
bankruptcies |
company_id |
integer | InfoTrie's identifier of the company. |
bankruptcies |
company_name |
string | The company's name. |
bankruptcies |
symbol |
string | The company's ticker. |
bankruptcies |
security_class |
string | The class of security concerned, as the filing names it. |
bankruptcies |
country |
string | The company's country; what the country parameter matches. |
bankruptcies |
date_announced |
string | The date the action was made public. |
bankruptcies |
source |
string | The public label of the source. |
acquisitions |
date_effective |
string | The date the action takes effect. The window filters on it. |
acquisitions |
company_id |
integer | InfoTrie's identifier of the company acquired. |
acquisitions |
company_name |
string | The name of the company acquired. |
acquisitions |
symbol |
string | The ticker of the company acquired. |
acquisitions |
accquirer_company_id |
integer | null (the field is spelled so in the response). |
acquisitions |
acquirer_name |
string | null. |
acquisitions |
acquirer_symbol |
string | null. |
acquisitions |
country |
string | The acquired company's country; what the country parameter matches. |
acquisitions |
date_announced |
string | The date the action was made public. |
acquisitions |
source |
string | The public label of the source. |
dividends |
company_id |
integer | InfoTrie's identifier of the company. |
dividends |
company_name |
string | The company's name. |
dividends |
symbol |
string | The company's ticker. |
dividends |
date_effective |
string | The ex-date. The window filters on it. |
dividends |
declaration_date |
string | The date the dividend was declared. |
dividends |
record_date |
string | null. |
dividends |
payment_date |
string | null. |
dividends |
period |
string | null. |
dividends |
value |
number | The amount per share. |
dividends |
adjusted_value |
number | null. |
dividends |
currency |
string | The currency of the amount, an ISO 4217 code. |
dividends |
exchange_code |
string | The code of the exchange the symbol trades on. |
dividends |
source |
string | The public label of the source. |
delisting_notices |
date_effective |
string | The date the action takes effect. The window filters on it. |
delisting_notices |
company_id |
integer | InfoTrie's identifier of the company. |
delisting_notices |
company_name |
string | The company's name. |
delisting_notices |
symbol |
string | The company's ticker. |
delisting_notices |
security_class |
string | The class of security concerned, as the filing names it. |
delisting_notices |
country |
string | The company's country; what the country parameter matches. |
delisting_notices |
date_announced |
string | The date the action was made public. |
delisting_notices |
source |
string | The public label of the source. |
Other corporate actions (rights issues, buybacks, mergers other than acquisitions, identifier changes other than symbol changes, meetings) are not served.