get_corporate_actions
Retrieve corporate action announcements like dividends, splits, and mergers for specified securities, with filtering by date, type, and symbols.
Instructions
Retrieves and formats corporate action announcements.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| symbols | No | A comma-separated list of symbols. | |
| cusips | No | A comma-separated list of CUSIPs. | |
| 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 | |
| start | No | The inclusive start of the interval. The corporate actions are sorted by their `process_date`. Format: YYYY-MM-DD. Default: current day. | |
| 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). | |
| 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. | |
| 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. | |
| sort | No | Sort data in ascending or descending order. | asc |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||