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_returns

The MCP tool for Returns by period. Each call costs 1 token(s).

Key points

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

What this tool returns

Returns price changes over 1 day, 1 week, 1 month, 3 months, 6 months, 1 year and year to date, plus the 3-year annualized return. These are the same figures as the quote endpoint, trimmed for ranking and comparison. Ratios are 0–1 decimals.

Description sent to AI clients

Lightweight price-change bundle: 1d/1w/1m/3m/6m/1y/YTD change percentages and 3y annualized return (0-1 fraction). Use for quick performance comparisons. 期間別騰落率と3年年率リターンの軽量版。

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

What you can answer with it

  • chatCompare the returns of several stocks side by side
  • chatList the last month and year-to-date performance

Arguments

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

ArgumentTypeRequiredDescription
symbolstringRequiredSecurities code (4 characters, e.g. 7203 = Toyota Motor; alphanumeric codes such as 130A also work)

REST endpoint

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

Examples

Example prompt

Using ZENITH Code data, help me with this: Compare the returns of several stocks side by side

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_returns",
    "arguments": {
      "symbol": "7203"
    }
  }
}

The same data over REST:

curl "https://api.zenithcode.net/stable/returns?symbol=7203" \
  -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.
  • infoPass a four-character securities code as symbol (e.g. 7203). If you only know the name, look it up with search_company first.
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_returns?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_returns cost per call?expand_more

1 token(s), the same as calling /stable/returns directly.

Can I show get_returns 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_returns return?expand_more

Returns price changes over 1 day, 1 week, 1 month, 3 months, 6 months, 1 year and year to date, plus the 3-year annualized return. These are the same figures as the quote endpoint, trimmed for ranking and comparison. Ratios are 0–1 decimals.

How can I verify the source of get_returns 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/returns API docs.

Which tools are used together with get_returns?expand_more

Common companions are get_quote, get_technicals, get_historical_prices. 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.