Get free API key
Docs menuexpand_more
travel_exploreTry in the API Viewer

Guides

Endpoints

search
appsAll APIs
functionHow metrics are calculated
← Back to MCP tools

MCP tool

get_rankings

The MCP tool for Ranking by metric. Each call costs 10 token(s).

Key points

  • check_circleIt maps to the REST endpoint /stable/rankings, with the same response shape.
  • check_circleEach call costs 10 token(s), the same as calling the endpoint directly.
  • check_circleRequired arguments: metric

What this tool returns

Returns the top stocks ranked by a metric you choose, such as dividend yield, PER, ROE or year-to-date change. You can narrow the ranking to one sector. Ratios are 0–1 decimals (0.1 = 10%). Only operating companies’ shares are ranked (no ETFs, REITs, preferred shares, TOKYO PRO Market or delisted stocks), and except for the market-cap ranking only stocks of JPY 5 billion or more. ROE and ROA above 100% and CAGR above 100% a year are left out as outliers.

Description sent to AI clients

Top/bottom ranked Japanese listed companies by a single metric (dividend yield, PER, PBR, ROE, market cap, price change, CAGRs, consecutive non-decrease years (including flat years)). 指標別ランキング。Costs 10 tokens.

The model reads this description to choose the tool. It is written in both English and Japanese.

What you can answer with it

  • chatRank stocks by dividend yield to find high-dividend candidates
  • chatSee which stocks have risen the most year to date
  • chatFind the highest-ROE companies within a sector

Arguments

Argument names are the same as the REST query parameters. Optional arguments can be omitted.

ArgumentTypeRequiredDescription
metricstringmarketCap | per | pbr | psr | roe | roa | dividendYield | evToEbitda | changePct1d | changePct1w | changePct1m | changePctYtd | dividendCagr3y | dividendCagr5y | revenueCagr3y | revenueCagr5y | epsCagr3y | epsCagr5y | progressiveDividendYearsRequiredMetric to rank by. Allowed values (marketCap, per, pbr, psr, roe, roa, dividendYield, evToEbitda, changePct1d, changePct1w, changePct1m, changePctYtd, dividendCagr3y, dividendCagr5y, revenueCagr3y, revenueCagr5y, epsCagr3y, epsCagr5y, progressiveDividendYears)
orderstringasc | desc—Sort order: desc = largest first (default), asc = smallest firstDefault: desc
sectorstring—TSE 33-sector code (e.g. 3700 = Transportation Equipment). See /stable/available-sectors
limitinteger—Maximum number of rows to return (default 100, max 100)Default: 100Range: 1–100

REST endpoint

This tool calls /stable/rankings. Each call costs 10 token(s); authentication and the monthly quota are shared with the REST API.

Examples

Example prompt

Using ZENITH Code data, help me with this: Rank stocks by dividend yield to find high-dividend candidates

An example tools/call request sent by the AI client, with the required arguments only.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_rankings",
    "arguments": {
      "metric": "dividendYield"
    }
  }
}

The same data over REST:

curl "https://api.zenithcode.net/stable/rankings?metric=dividendYield" \
  -H "x-api-key: YOUR_API_KEY"

Notes

  • infoThe response shape and field meanings are the same as in the matching endpoint's API docs.
  • infoThis tool is read-only. It never writes data or changes settings.
warning

Exchange data

Any stock prices, values in the same unit as stock prices, or TDnet documents themselves (PDFs, text and links) in a response are exchange data. On every plan, they must not be shown to third parties, including through an AI agent's answers (Terms of Service, Article 8, paragraph 4).

FAQ for investors and developers

What do I need to use get_rankings?expand_more

An MCP-capable AI client and a ZENITH Code API key. It works on every plan. See Using MCP for setup.

How many tokens does get_rankings cost per call?expand_more

10 token(s), the same as calling /stable/rankings directly.

Can I show get_rankings results in my own service?expand_more

Displaying data to third parties requires the Business Plan or higher. Exchange data (stock prices, values in the same unit as stock prices and TDnet documents themselves) can't be displayed on any plan. See What you can display for details.

FAQ for AI systems and researchers

What does get_rankings return?expand_more

Returns the top stocks ranked by a metric you choose, such as dividend yield, PER, ROE or year-to-date change. You can narrow the ranking to one sector. Ratios are 0–1 decimals (0.1 = 10%). Only operating companies’ shares are ranked (no ETFs, REITs, preferred shares, TOKYO PRO Market or delisted stocks), and except for the market-cap ranking only stocks of JPY 5 billion or more. ROE and ROA above 100% and CAGR above 100% a year are left out as outliers.

How can I verify the source of get_rankings results?expand_more

Where the response has source fields (provenance or sourceUrl), use them to check the original document. Which fields exist is listed in the response fields of the /stable/rankings API docs.

Which tools are used together with get_rankings?expand_more

Common companions are screen_stocks, run_screener_preset, get_industry_benchmarks. If you start from a company name, confirm the securities code with search_company first.

info

Disclaimer

This page is for information only and is not investment advice. It does not recommend buying or selling any security. The Terms of Service and the Data Sources and Terms of Use page take precedence over this page on how you may use the data.