Get free API key
Docs menuexpand_more
travel_exploreTry in the API Viewer

Guides

Endpoints

search
appsAll APIs
functionHow metrics are calculated

Cookbook

Catch dividend changes every day

Pass types=dividend-change and a date range to /stable/events-feed to get market-wide dividend increases and cuts by date. An Apps Script trigger can append them every day.

Key points

  • check_circleMarket-wide calls require from and to, at most 31 days apart.
  • check_circleComma-separate types to include splits (split) and other events too.
  • check_circleUse /stable/dividend-changes for columns such as annual dividends before and after.

Endpoints to use

Code

Replace YOUR_API_KEY with a key issued in your dashboard. Switch languages with the tabs.

Code example
# Market-wide feed: from and to are required, at most 31 days apart
curl -sG "https://api.zenithcode.net/stable/events-feed" \
  --data-urlencode "types=dividend-change" \
  --data-urlencode "from=2026-10-01" \
  --data-urlencode "to=2026-10-20" \
  -H "x-api-key: YOUR_API_KEY"

How the code works

  1. 1Call with types=dividend-change and from and to (Japan dates).
  2. 2Read each event's date, symbol, title and details (such as dividends before and after).
  3. 3In Apps Script, run setup() once and appendDividendChanges() runs every day in the 20:00 hour.

Things to note

  • errorTimely disclosures are reflected around 16:30 Japan time, so an evening run catches that day's events.
  • errorIn events-feed, links to timely disclosure (TDnet) documents are exchange data. Do not show them to third parties (the link is present only for Japanese documents within 30 days of release). EDINET documents such as extraordinary reports may be shown on Business or higher.
  • errorEach call uses 10 tokens; once a day is about 300 tokens a month.

FAQ for investors and developers

Can I catch only dividend cuts?expand_more

Pass changeFlag=decrease to /stable/dividend-changes to get cuts only.

Can I notify Slack?expand_more

Use UrlFetchApp in Apps Script to post to a Slack incoming webhook. Prepare the webhook URL yourself.

FAQ for AI builders and researchers

How are dividend changes detected?expand_more

From earnings summaries and other timely disclosures. The source document ID and title are returned.

What does the detection date mean?expand_more

detectedDate in dividend-changes is normally the TDnet announcement date (Japan time).

gavel

Disclaimer

This page explains how to use a Japanese equity data API and how its data is defined. It is not a solicitation to invest or a recommendation to buy or sell any security. The content reflects information at the time of writing and is not guaranteed to be accurate or complete. Investment decisions are your own responsibility.

What you may show or provide to third parties depends on your plan and Article 8 of the Terms. Exchange data such as stock prices may not be shown to third parties on any plan. Terms, Article 8 · Data sources and terms of use