Dividends
StandardPro
REQUIRED
The Theta Terminal must be running to access data.
Behavior
A stock dividend message is generally reported on the ex-dividend date.
Sample URL
Paste the URL below into your browser while the Theta Terminal is running.
http://127.0.0.1:25510/v2/hist/stock/dividend?root=AAPL&start_date=20240101&end_date=20240601
Output Descriptions
| Field | Description |
|---|---|
| ms_of_day | The time of the report. Milliseconds since 00:00:00.000 (midnight) ET. |
| ex_date | The ex-dvidend date date formated as YYYYMMDD. |
| record_date | The record date formated as YYYYMMDD. |
| payment_date | The payment date formated as YYYYMMD |
| ann_date | The announcement date formated as YYYYMMDD. |
| dividend_amount | The dividend amount in USD. |
| undefined | placeholder / future use. This can be ignored. |
| less_amount | Fees deducted from the dividend_amount |
| date | The date formated as YYYYMMDD. |
Parameters
Query Parameters
rootRequired -
The symbol of the security. Option underlyings for indices might have special tickers.
Type: string (Default: SPX)
use_csvRequired -
Uses CSV if true, legacy JSON if false.
Type: boolean (Default: false)
start_dateRequired -
The start date (inclusive) of the request formatted as YYYYMMDD.
Type: integer (Default: 20230915)
end_dateRequired -
The end date (inclusive) of the request formatted as YYYYMMDD.
Type: integer (Default: 20230915)
Sample Code
py