/minkabu/stocks/dividends

POST /api/minkabu/stocks/dividends

Price: 10 credits

Get a Japanese listed stock's dividends from Minkabu: current yield, payout ratio and record months, and per fiscal year the interim, year-end, total and split-adjusted dividend, yield, average price, payout ratio, EPS, DOE and ROE, with the company's forecast year

How to use it

Dividends are yen per share; yields and ratios are percent.

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 minkabu.jp stock URL (examples: "7203", "167A", "https://minkabu.jp/stock/6758")

Response

• @type string (default: "MinkabuDividends")
• code string required
• name string nullable
• url string required
• dividend_yield number nullable
• payout_ratio number nullable
• record_months array (default: [])
• years array (default: [])
  • @type string (default: "MinkabuDividendYear")
  • period string required
  • is_forecast boolean (default: false)
  • interim number nullable
  • year_end number nullable
  • total number nullable
  • adjusted_total number nullable
  • dividend_yield number nullable
  • average_price number nullable
  • payout_ratio number nullable
  • eps number nullable
  • doe number nullable
  • roe number 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 Minkabu 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.