v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB

Corporate Actions

Retrieve Announcements

This endpoint is deprecated, please use the new corporate actions endpoint instead.

get/v1/corporate_actions/announcements

Query parameters

ca_typesstring required

A comma-delimited list of CorporateActionType values

sincestring date required

The start (inclusive) of the date range when searching corporate action announcements. This should follow the YYYY-MM-DD format. The date range is limited to 90 days.

untilstring date required

The end (inclusive) of the date range when searching corporate action announcements. This should follow the YYYY-MM-DD format. The date range is limited to 90 days.

symbolstring

The symbol of the company initiating the announcement.

cusipstring

The CUSIP of the company initiating the announcement.

date_type'declaration_date' | 'ex_date' | 'record_date' | 'payable_date'

An emum of possible ways to use the since and until parameters to search by.

the types are:

declaration_date: The date of the preliminary announcement details or the date that any subsequent term updates took place.
ex_date: The date on which any security purchasing activity will not result in a corporate action entitlement. Any selling activity that takes place on or after this date will result in a corporate action entitlement.
record_date: The date the company checks its records to determine who is shareholder in order to allocate entitlements.
payable_date: The date that the stock and cash positions will update according to the account positions as of the record date.

Response

Announcements have both a type and a subtype to categorize them. This model represents the lowever level abstract "sub types" of Announcement. Please see the AnnouncementCAType model for higher level descriptions of the possible types

Possible values are:

from the dividend type:
- cash
  
  A cash payment based on the number of shares the account holds on the record date.
- stock
  
  A stock payment based on the number of shares the account holds on the record date.
from the merger type:
- merger_update
  
  An update to the terms of an upcoming merger. This can happen any number of times before the merger is completed and can be tracked by using the id parameter.
- merger_completion
  
  A final update in the terms of the merger in which the intiating_symbol will acquire the target_symbol. Any previous terms updates for this announcement will have the same id value.
from the split type:
- stock_split
  
  An increase in the number of shares outstanding with a decrease in the dollar value of each share. The new_rate and old_rate parameters will be returned in order to derive the ratio of the split
- until_split
  
  An increase in the number of shares outstanding with a decrease in the dollar value of each share. The new_rate and old_rate parameters will be returned in order to derive the ratio of the split.
- reverse_split
  
  A decrease in the number of shares outstanding with an increase in the dollar value of each share. The new_rate and old_rate parameters will be returned in order to derive the ratio of the spli
- recapitalization
  
  A stock recapitalization, typically used by a company to adjust debt and equity ratios.
from the spinoff type:
- spinoff
  
  A disbursement of a newly tradable security when the intiating_symbol creates the target_symbol.

ca_type'dividend' | 'merger' | 'split' | 'spinoff' required

Announcements have both a type and a subtype to categorize them. This model represents the higher level abstract "types" of Announcement. Please see the AnnouncementCASubType model for finer grain descriptions of the subtypes

Possible values are:

dividend can have cash and stock subtypes
merger has merger_update and merger_completion sub types
split has stock_split, until_split, reverse_split, and recapitalization sub types
spinoff currently has only the spinoff subtype and thus is just this higher level category for now. A disbursement of a newly tradable security when the intiating_symbol creates the target_symbol.

cashstring nullable required

The amount of cash to be paid per share held by an account on the record date.

corporate_action_idstring required

ID that remains consistent across all announcements for the same corporate action. Unlike 'id', this can be used to connect multiple announcements to see how the terms have changed throughout the lifecycle of the corporate action event.

declaration_datestring required

Date the corporate action or subsequent terms update was announced.

ex_datestring nullable required

The first date that purchasing a security will not result in a corporate action entitlement.

idstring required

ID that is specific to a single announcement.

initiating_original_cusipstring required

CUSIP of the company initiating the announcement.

initiating_symbolstring required

Symbol of the company initiating the announcement.

new_ratestring nullable required

The numerator to determine any quantity change ratios in positions.

old_ratestring nullable required

The denominator to determine any quantity change ratios in positions.

payable_datestring required

The date the announcement will take effect. On this date, account stock and cash balances are expected to be processed accordingly.

record_datestring nullable required

The date an account must hold a settled position in the security in order to receive the corporate action entitlement.

target_original_cusipstring nullable required

CUSIP of the child company involved in the announcement.

target_symbolstring nullable required

Symbol of the child company involved in the announcement.

Example response

[
  {
    "ca_type": "dividend"
  }
]