All Payouts by Date Range

Retrieve payout information for all stocks within a specified date range.

GET/3.0/payouts/date-range

Description

This endpoint returns comprehensive payout records (dividends, splits, bonus, rights) for all companies within a specified date range. It's useful for analyzing payout activity in a specific period and identifying all corporate actions that occurred during that timeframe.

Request

Authentication

• Type: Bearer Token
• Required: Yes

Parameters

Name	Type	Required	Description	Example
from	string	Yes	Start date for payout records (YYYY-MM-DD)	2024-01-01
to	string	Yes	End date for payout records (YYYY-MM-DD)	2024-12-31

Response

Success Response (200)

{
  "status": "ok",
  "message": "",
  "data": [
    {
      "id": "WAFI_20241115",
      "symbol": "WAFI",
      "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
    }
  ]
}

Response Fields

Field	Type	Description
id	string	Unique payout 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
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	integer	Stock split numerator
split_den	integer	Stock split denominator

Error Responses

For detailed Common Error responses, see the Error Handling.

Missing Parameters (200)

{
  "status": "error",
  "message": "Missing 'from' and `to` parameters"
}

Examples

Get Payouts for a Specific Period

curl -X GET "https://csapis.com/3.0/payouts/date-range?from=2024-01-01&to=2024-12-31" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Use Cases

• Period Analysis: Analyze all payouts in a specific time period
• Corporate Action Calendar: Build a corporate action calendar for a period
• Payout History: Track all payout events chronologically
• Market Activity: Monitor overall market payout activity
• Dividend Season Analysis: Analyze dividend patterns during specific seasons
• Event-Based Strategies: Identify and analyze payout-related trading opportunities