ETF Payouts
Retrieve dividend and income distribution information for ETFs.
GET/3.0/etf/payout
Description
This endpoint returns dividend and distribution history for an ETF, including distribution amounts, frequencies, ex-dates, payment dates, and yield information. Useful for income analysis and dividend planning.
Request
Authentication
- Type: Bearer Token
- Required: Yes
Parameters
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
symbol | string | Yes | ETF symbol/ticker code | UBLPETF |
Response
Success Response (200)
{
"status": "ok",
"message": "",
"data": [
{
"id": "UBLPETF_20241115",
"symbol": "UBLPETF",
"title": "Dividend Announcement",
"date": "2024-11-15",
"ex_date": "2024-11-10",
"book_closure_from": "2024-11-12",
"book_closure_to": "2024-11-14",
"entitlement_date": "2024-11-09",
"dividend": 2.50,
"bonus": 0.0,
"right_price": 0.0,
"right_issue": 0.0,
"split_num": 0,
"split_den": 0
},
{
"id": "UBLPETF_20240515",
"symbol": "UBLPETF",
"title": "Rights Issue Announcement",
"date": "2024-05-15",
"ex_date": "2024-05-10",
"book_closure_from": "2024-05-12",
"book_closure_to": "2024-05-14",
"entitlement_date": "2024-05-09",
"dividend": 0.0,
"bonus": 0.0,
"right_price": 150.0,
"right_issue": 0.5,
"split_num": 0,
"split_den": 0
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
title | string | Payout announcement title |
date | string | Announcement/publication date (YYYY-MM-DD) |
ex_date | string | Ex-date for the payout |
book_closure_from | string | Book closure start date |
book_closure_to | string | Book closure end date |
entitlement_date | string | Entitlement date |
dividend | number | Dividend per share |
bonus | number | Bonus shares ratio |
right_price | number | Right issue price |
right_issue | number | Right issue ratio |
split_num | number | Stock split numerator |
split_den | number | Stock split denominator |
Error Responses
For detailed Common Error responses, see the Error Handling.
Missing Symbol (200)
{
"status": "error",
"message": "`symbol` parameter required"
}
Examples
Get ETF Payout History
curl -X GET "https://csapis.com/3.0/etf/payout?symbol=UBLPETF" \
-H "Authorization: Bearer YOUR_API_TOKEN"
Use Cases
- Income Planning: Track regular dividend distributions for income planning
- Yield Analysis: Analyze distribution yield and consistency
- Tax Planning: Plan tax implications based on distribution type and amount
- Total Return Calculation: Include distributions in total return analysis
- Reinvestment Strategy: Track distributions for dividend reinvestment decisions