Skip to content

V3_CORPORATE_ACTION_DIVIDEND() ​

StandardPro
  • Returns the dividend events for a symbol with an ex-date between the specified dates (inclusive).
  • One row per payment, not per tax-character component, so summing amount over a period gives that period's total. Where the source published a payment only as its parts, those parts are returned instead and flagged with is_component; a payment is never returned both ways.

Example ​

=THETADATA.V3_CORPORATE_ACTION_DIVIDEND("AAPL", "20200101", "20240101")

Parameters ​

symbolRequired  -

The stock or index symbol, or underlying symbol for options.

Type: string
Behavior: Required.
start_dateRequired  -

The start date (inclusive).

Type: string
Behavior: Required.
end_dateRequired  -

The end date (inclusive).

Type: string
Behavior: Required.

Returns ​

A grid (string[][]) - a header row followed by one row per result. See the REST API reference for the full response schema.