Fundamental
Authorization
Signed mode: every request is signed with your App Key/Secret. Header set:
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string · header | Required | The account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation. |
X-Api-Key | string · header | Required | Your App Key. |
X-Timestamp | string · header | Required | Request timestamp in seconds (Unix epoch). |
X-Api-Signature | string · header | Required | HMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=. |
Get dividend history and upcoming dividend announcements for a security.
Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
symbol | string | Required | Security symbol, e.g. `AAPL.US` |
start_date | string | Optional | Start date in `YYYY-MM-DD` format |
end_date | string | Optional | End date in `YYYY-MM-DD` format |
Response
Response properties
| Name | Type | Required | Description |
|---|---|---|---|
list | object[] | Optional | Dividend records |
└ id | string | Optional | Dividend event ID |
└ desc | string | Optional | Dividend description |
└ symbol | string | Optional | Security symbol |
└ record_date | string | Optional | Record date |
└ ex_date | string | Optional | Ex-dividend date |
└ payment_date | string | Optional | Payment date |
└ dividend_summary | object | Optional | Dividend summary. |
└ ∟ title | string | Optional | Topic title |
└ ∟ desc | string | Optional | Dividend description |
total | string | Optional | Total number of matching stocks. |
Response JSON example
{
"code": 0,
"message": "success",
"data": {
"list": [
{
"id": "12345",
"symbol": "AAPL.US",
"ex_date": "2026-02-07",
"payment_date": "2026-02-13",
"record_date": "2026-02-10",
"desc": "Cash dividend 0.25 USD"
}
]
}
}Error code
See the Error Codes page for the full list of error codes.