list_corporate_actions
TOOLList corporate actionsscope: dataflow:calendar.read · read-only
Tool description, as exposed to the agent
Returns a company's corporate actions over a lookback window — dividends, share splits, rights/bonus/directed share issues, and redemptions — as one merged, dated timeline. Use search_securities first to obtain the company_id. Corporate actions change a company's share count or pay out capital, so this tool explains discontinuities you see in ownership, share-count, or holding data. Each row has an action_type (dividend, redemption, split, issue) and the fields relevant to it: dividends carry the amount, currency, payment and record dates; splits and issues carry the new:old share ratio; issues also carry the issue type and subscription price. Results are ordered most-recent first; when next_cursor is present in the response, pass it back as cursor on the next call to receive the next page. The default window is one year; the maximum is five. Successful calls may consume Dataflow credits.Parameters
| Parameter | Type | Description | |
|---|---|---|---|
| company_id | integer | required | Company whose corporate actions to list, from search_securities. Nonzero integer; the sign of the ID has NO meaning; negative IDs are normal and are NOT a flag for 'unlisted', 'private', or anything else. Pass it through verbatim. |
| days | integer | optional | Lookback window in calendar days from today (UTC). Default 365 (corporate actions are infrequent), max 1825 (five years).default 365 · min 1 · max 1825 |
| limit | integer | optional | Maximum number of actions per page, ordered by date descending. Hard cap 50.default 20 · min 1 · max 50 |
| cursor | string | optional | Opaque pagination token from a prior call's next_cursor. Omit for the first page. |
Billing
Pricing key: calendar.corporate_actions. Successful calls consume Dataflow credits per your contract. See Credits & pricing.