Bonus

Retrieve bonus shares information for selected company over the latest 5 years.

GET/3.0/payouts/bonus

Description

This endpoint provides comprehensive bonus shares data for all companies in the market covering the last 5 years. It includes bonus ratios, announcement dates, ex-dates, and implementation details for tracking capital appreciation through bonus allocations.

Request

Authentication

• Type: Bearer Token
• Required: Yes

Parameters

Name	Type	Required	Description	Example
symbol	string	Yes	Stock symbol/ticker code	WAFI

Response

Success Response (200)

{
  "status": "ok",
  "message": "",
  "data": [
    {
      "id": "WAFI_20240815",
      "symbol": "WAFI",
      "title": "Bonus Shares Announcement",
      "date": "2024-08-15",
      "ex_date": "2024-08-10",
      "book_closure_from": "2024-08-12",
      "book_closure_to": "2024-08-14",
      "entitlement_date": "2024-08-09",
      "bonus": 1.0
    }
  ]
}

Response Fields

Field	Type	Description
id	string	Record identifier
symbol	string	Stock symbol/ticker code
title	string	Payout announcement title
date	string	Announcement/publication date (YYYY-MM-DD)
ex_date	string	Ex-date for the payout (YYYY-MM-DD)
book_closure_from	string	Book closure start date (YYYY-MM-DD)
book_closure_to	string	Book closure end date (YYYY-MM-DD)
entitlement_date	string	Entitlement date (YYYY-MM-DD)
bonus	number	Bonus shares ratio

Error Responses

For detailed Common Error responses, see the Error Handling.

Missing Symbol (200)

{
  "status": "error",
  "message": "'symbol' parameter not provided"
}

Examples

Get Latest Bonus Shares

curl -X GET "https://csapis.com/3.0/payouts/bonus?symbol=WAFI" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Use Cases

• Capital Appreciation Tracking: Monitor bonus share allocations
• Cost Base Adjustment: Adjust investment cost base for bonus shares
• Returns Calculation: Include bonus shares in return calculations
• Dividend History Analysis: Understand capital structure evolution
• Portfolio Valuation: Adjust share count for historical valuations
• Market Trends: Analyze bonus distribution patterns across market