Dividend (v3)
StandardPro
REQUIRED
The v3 Theta Terminal must be running to access data.
- 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
amountover a period gives that period's total. Where the source published a payment only as its parts, those parts are returned instead and flagged withis_component; a payment is never returned both ways.
Sample URL
Paste the URL below into your browser while the Theta Terminal is running.
Returns the dividends for a given symbol between specified dates (inclusive)
http://127.0.0.1:25503/v3/corporate_action/dividend?symbol=AAPL&start_date=20200101&end_date=20240101Query Parameters
symbolRequired -
The stock or index symbol, or underlying symbol for options.
Type: string
start_dateRequired -
The start date (inclusive).
Type: string
end_dateRequired -
The end date (inclusive).
Type: string
format -
The format of the data when returned to the user.
Type: string (Default: csv)
Enumcsv, json, ndjson, html
Responses
Returns the dividend events for a given symbol between specified dates (inclusive)
array of:
Sample Code
py