/kabutan/stocks

POST /api/kabutan/stocks

Price: 5 credits

Get a Japanese listed stock from Kabutan by TSE code: quote with change and the day's session, PTS quote, PER, PBR, PSR, dividend yield, margin ratio and weekly margin balances, market cap, shares outstanding, moving-average deviations, recent and forecast annual results, English name, website, business summary, industry, themes and peer stocks

How to use it

Use kabutan/stocks/financials for the full results history and kabutan/stocks/prices for price history.

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: "KabutanStock")
• code string required
• name string required
• url string required
• market string nullable
• badges array (default: [])
• industry string nullable
• price number nullable
• price_at integer nullable
• change number nullable
• change_percent number nullable
• previous_close number nullable
• previous_close_date integer nullable
• pts_price number nullable
• pts_at integer nullable
• per number nullable
• pbr number nullable
• psr number nullable
• dividend_yield number nullable
• margin_ratio number nullable
• market_cap integer nullable
• shares_outstanding integer nullable
• unit_shares integer nullable
• minimum_purchase integer nullable
• session object nullable
  • @type string (default: "KabutanTradingSession")
  • date integer nullable
  • open object nullable
    • @type string (default: "KabutanPriceMark")
    • price number nullable
    • time integer nullable
  • high object nullable
    • @type string (default: "KabutanPriceMark")
    • price number nullable
    • time integer nullable
  • low object nullable
    • @type string (default: "KabutanPriceMark")
    • price number nullable
    • time integer nullable
  • close object nullable
    • @type string (default: "KabutanPriceMark")
    • price number nullable
    • time integer nullable
  • last object nullable
    • @type string (default: "KabutanPriceMark")
    • price number nullable
    • time integer nullable
  • volume integer nullable
  • turnover integer nullable
  • vwap number nullable
  • trade_count integer nullable
• pts_session object nullable
  • @type string (default: "KabutanTradingSession")
  • date integer nullable
  • open object nullable
    • @type string (default: "KabutanPriceMark")
    • price number nullable
    • time integer nullable
  • high object nullable
    • @type string (default: "KabutanPriceMark")
    • price number nullable
    • time integer nullable
  • low object nullable
    • @type string (default: "KabutanPriceMark")
    • price number nullable
    • time integer nullable
  • close object nullable
    • @type string (default: "KabutanPriceMark")
    • price number nullable
    • time integer nullable
  • last object nullable
    • @type string (default: "KabutanPriceMark")
    • price number nullable
    • time integer nullable
  • volume integer nullable
  • turnover integer nullable
  • vwap number nullable
  • trade_count integer nullable
• margin_balances array (default: [])
  • @type string (default: "KabutanMarginBalance")
  • date integer nullable
  • sell_balance integer nullable
  • buy_balance integer nullable
  • ratio number nullable
• ma_deviation_5d number nullable
• ma_deviation_25d number nullable
• ma_deviation_75d number nullable
• ma_deviation_200d number nullable
• results array (default: [])
  • @type string (default: "KabutanResult")
  • period string required
  • accounting_standard string nullable
  • is_forecast boolean (default: false)
  • revenue integer nullable
  • ordinary_profit integer nullable
  • net_profit integer nullable
  • eps number nullable
  • dividend number nullable
  • announced_date integer nullable
• english_name string nullable
• website string nullable
• summary string nullable
• themes array (default: [])
• peers array (default: [])
  • @type string (default: "KabutanPeer")
  • code string required
  • name string nullable
• other_details array (default: [])
  • @type string (default: "KabutanMetric")
  • label string required
  • value string required

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.