/kabutan/stocks/shareholders

POST /api/kabutan/stocks/shareholders

Price: 5 credits

Get a Japanese listed stock's major shareholders from Kabutan for its latest report: holder name, holding ratio, shares and change since the previous report, plus the top funds holding it and the latest shareholder and capital news

How to use it

Only the latest report is served: period names it and periods lists the report dates Kabutan shows.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• code string required — TSE stock code or kabutan.jp stock URL (examples: "7203", "167A", "https://kabutan.jp/stock/?code=6758", "https://s.kabutan.jp/stocks/7203/")
• report integer — Shareholder report to read; only the latest report, 0, is available (default: 0; min: 0; max: 5)

Response

• @type string (default: "KabutanShareholders")
• code string required
• url string required
• period string nullable
• periods array (default: [])
• shareholders array (default: [])
  • @type string (default: "KabutanShareholder")
  • name string required
  • holding_ratio number nullable
  • shares integer nullable
  • change string nullable
  • holder string nullable
• funds array (default: [])
  • @type string (default: "KabutanFund")
  • rank integer nullable
  • name string required
  • manager string nullable
  • trustee string nullable
  • url string nullable
• news array (default: [])
  • @type string (default: "KabutanNewsItem")
  • id string required
  • url string required
  • category string nullable
  • published_at integer nullable

Errors

• 422 — code is not a TSE stock code Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No Kabutan stock under that code Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.