/kabutan/stocks/perks

POST /api/kabutan/stocks/perks

Price: 5 credits

Get a Japanese listed stock's shareholder perks (株主優待) from Kabutan: perk and dividend yields, record months, last trading day with rights, minimum shares and investment, categories, each perk with its share tiers and notes, and perk-related news

How to use it

has_perks is false for a stock that offers no shareholder perks.

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/")

Response

• @type string (default: "KabutanPerks")
• code string required
• url string required
• has_perks boolean required
• summary string nullable
• updated_date integer nullable
• total_yield number nullable
• perk_yield number nullable
• dividend_yield number nullable
• record_months string nullable
• long_term_benefit string nullable
• last_trading_day integer nullable
• liquidity string nullable
• minimum_shares integer nullable
• minimum_investment integer nullable
• categories array (default: [])
• company_page string nullable
• perks array (default: [])
  • @type string (default: "KabutanPerk")
  • name string required
  • record_month string nullable
  • tiers array (default: [])
    • @type string (default: "KabutanPerkTier")
    • required_shares string required
    • content string nullable
  • notes 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.