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
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)
Responses
OK
JSON
{
"header": {
"id": 0,
"latency_ms": 0,
"error_type": "string",
"error_msg": "string",
"next_page": null,
"format": [
"ms_of_day",
"ex_date",
"record_date",
"payment_date",
"ann_date",
"dividend_amount",
"undefined",
"less_amount",
"date"
]
},
"response": [
[
3600000,
20240209,
20240212,
20240215,
20240201,
0.24,
0,
0,
20240209
],
[
3600000,
20240510,
20240513,
20240516,
20240502,
0.25,
0,
0,
20240510
]
]
}
Sample Code
py