Twelve Data Get Dividends
5 credits/call
ae_twelvedata_get_dividends
Get a stock's dividend history from Twelve Data, including ex-dividend dates, amounts, and frequency.
5 credits/call
Pricing
5 credits/call
| Condition | Charge |
|---|---|
| Each call | 5 credits/call |
Parameters
Optional parameters use the platform defaults when omitted.
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
isin | string | Conditional | ISIN of the instrument. Use a real non-empty identifier; if this instrument is unavailable by ISIN, resolve its ticker symbol first. | — |
cusip | string | Conditional | CUSIP of the instrument. Use a real non-empty identifier; if this instrument is unavailable by CUSIP, resolve its ticker symbol first. | — |
range | enum (last | next | 1m | 3m | 6m | ytd | 1y | 2y | 5y | full) | No | Specifies the time range for which to retrieve dividend data. Accepts values such as `last` (most recent dividend), `next` (upcoming dividend), `1m` - `5y` for respective periods, or `full` for all available data. If provided together with `start_date` and/or `end_date`, this parameter takes precedence. | last |
adjust | boolean | No | Specifies if there should be an adjustment | true |
symbol | string | Conditional | Ticker symbol of the instrument, for example AAPL, EUR/USD or ETH/BTC. Use a real non-empty symbol; a supported ISIN or CUSIP may be used instead when this endpoint accepts it. | — |
country | string | No | Country where instrument is traded, e.g., `United States` or `US` | — |
end_date | string | No | End date for the dividend data query. Only dividends with dates on or before this date will be returned. Format `2006-01-02`. If provided together with `range` parameter, `range` will take precedence. | — |
exchange | string | No | Exchange where instrument is traded | — |
mic_code | string | No | Market Identifier Code (MIC) under ISO 10383 standard | — |
start_date | string | No | Start date for the dividend data query. Only dividends with dates on or after this date will be returned. Format `2006-01-02`. If provided together with `range` parameter, `range` will take precedence. | — |
Invocation example
Copy the request and explore its response example.
POST
/agent-api/v1/tool/executeX-Api-KeyRequest coderequest.sh
curl --request POST \
--url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_twelvedata_get_dividends' \
--header "X-Api-Key: $AGENTEARTH_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"params": {
"exchange": "NASDAQ",
"symbol": "AAPL"
}
}'Response exampleresponse.json
"当前用户已跳过第三方工具调用"
