Docs menuexpand_more
Cookbook
Cookbook: common tasks in a few lines
Key points
- check_circleEach recipe follows the same order: endpoints, code, how the code works, things to note and FAQ.
- check_circleReplace YOUR_API_KEY in the code with a key issued in your dashboard and it runs.
- check_circleFinished examples with screens are on the guides page; endpoint details are in the API reference.
Recipes
- searchFind a securities code by company nameSearch by part of a company name to get securities codes and Japanese and English names./search-name
- bar_chartChart dividend historyGet annual dividends by fiscal year and growth streaks, then draw a bar chart./dividend-streaks /dividends
- functionsCompute trailing twelve-month (TTM) revenueTurn year-to-date quarterly revenue into a trailing twelve-month total./income-statement /key-metrics
- notificationsCatch dividend changes every dayPick dividend increases and cuts out of the market-wide event feed and append them to a sheet daily./events-feed /dividend-changes
- eventList upcoming earnings datesGet earnings dates for the next two weeks and keep only your holdings./earnings-calendar
- table_viewExport to Google SheetsFetch with ?format=csv and refresh a sheet daily with Apps Script. Excel Power Query too./industry-benchmarks
- compare_arrowsCompare companies in the same sectorPut a company, same-sector companies of similar size and the sector median in one table./peers /industry-benchmarks
- groupsTrack large shareholdingsFetch large shareholding reports as they are filed and list changes in holding ratios./large-holding-reports /large-holders
- account_treeRead every line item as a hierarchyPrint every filed line item, indented by its parent-child structure./financial-statement-full /financial-facts
What every recipe assumes
Every recipe works on these basics.
- Base URL
- https://api.zenithcode.net/stable
- Authentication
- Put your API key in the x-api-key header (Authorization: Bearer also works). ?apikey= in the URL is not supported.
- Response shape
- Most endpoints return a JSON array. Add ?format=csv to get the same rows as CSV.
- Units
- Amounts are in yen, ratios are 0–1 decimals (0.0323 = 3.23%) and multiples are plain numbers. null means "not disclosed" or "cannot be computed", not zero.
- Tokens
- Each endpoint has a fixed cost per call, shown under "Endpoints to use" in each recipe.
FAQ for investors and developers
Does the code run as is?expand_more
Yes, once you replace YOUR_API_KEY with your key. Python uses requests (plus matplotlib or pandas for charts and tables); JavaScript uses fetch in a browser or Node.js 18+.
What if I do not program?expand_more
Paste the Google Apps Script tab into Extensions > Apps Script in a spreadsheet.
Can I try them on the Free plan?expand_more
Yes. Free includes 5,000 tokens a month. Check each recipe's token cost.
FAQ for AI builders and researchers
Can an AI agent do the same tasks?expand_more
MCP-compatible AI clients can do the same work with tools that call the same endpoints. Use these recipes to check the steps.
Are the endpoints and parameters in the examples correct?expand_more
They use only paths and parameters checked against the published API catalog (generated from OpenAPI).
May I show the data to others?expand_more
It depends on your plan and Article 8 of the Terms. Free and Pro are limited to your own (or internal company) use, and exchange data such as stock prices may not be shown to third parties on any plan.
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