get_corporate_actions
Retrieve corporate action announcements such as dividends, splits, and mergers, filtered by symbol, type, date range, or CUSIP. Get formatted data sorted by process date for analysis.
Instructions
Retrieves and formats corporate action announcements.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | The inclusive end of the interval. The corporate actions are sorted by their `process_date`. Format: YYYY-MM-DD. Default: current day. | |
| ids | No | A comma-separated list of corporate action IDs. This parameter is mutually exclusive with all other filters (symbols, types, start, end). | |
| sort | No | Sort data in ascending or descending order. | asc |
| limit | No | Maximum number of corporate actions to return in a response. The limit applies to the total number of data points, not the count per symbol! Use `next_page_token` to fetch the next set of corporate actions. | |
| start | No | The inclusive start of the interval. The corporate actions are sorted by their `process_date`. Format: YYYY-MM-DD. Default: current day. | |
| types | No | A comma-separated list of types. If not provided, search all types. The following types are supported: - reverse_split - forward_split - unit_split - cash_dividend - stock_dividend - spin_off - cash_merger - stock_merger - stock_and_cash_merger - redemption - name_change - worthless_removal - rights_distribution - partial_call - reorganization | |
| cusips | No | A comma-separated list of CUSIPs. | |
| region | No | The region to filter corporate actions by. - `us`: only US corporate actions - `non_us`: only non-US corporate actions - `all`: both US and non-US corporate actions | us |
| symbols | No | A comma-separated list of symbols. | |
| page_token | No | The pagination token from which to continue. The value to pass here is returned in specific requests when more data is available, usually because of a response result limit. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||