/kabutan/stocks/financials

POST /api/kabutan/stocks/financials

Price: 5 credits

Get a Japanese listed stock's results history from Kabutan: annual, half-year, quarterly and year-to-date results with forecasts, revenue, operating, ordinary and net profit, EPS, dividend, margins, ROE, ROA, cash flows and balance-sheet figures, each with its announcement date

How to use it

Money values are in yen. A period with is_forecast true is the company's own forecast.

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: "KabutanFinancials")
• code string required
• url string required
• annual array (default: [])
  • @type string (default: "KabutanFinancialPeriod")
  • period string required
  • accounting_standard string nullable
  • is_forecast boolean (default: false)
  • revenue integer nullable
  • operating_profit integer nullable
  • ordinary_profit integer nullable
  • net_profit integer nullable
  • eps number nullable
  • dividend number nullable
  • operating_margin number nullable
  • progress_rate number nullable
  • roe number nullable
  • roa number nullable
  • total_asset_turnover number nullable
  • free_cash_flow integer nullable
  • operating_cash_flow integer nullable
  • investing_cash_flow integer nullable
  • financing_cash_flow integer nullable
  • cash integer nullable
  • cash_ratio number nullable
  • bps number nullable
  • equity_ratio number nullable
  • total_assets integer nullable
  • equity integer nullable
  • retained_earnings integer nullable
  • debt_equity_ratio number nullable
  • announced_date integer nullable
• half_year array (default: [])
  • @type string (default: "KabutanFinancialPeriod")
  • period string required
  • accounting_standard string nullable
  • is_forecast boolean (default: false)
  • revenue integer nullable
  • operating_profit integer nullable
  • ordinary_profit integer nullable
  • net_profit integer nullable
  • eps number nullable
  • dividend number nullable
  • operating_margin number nullable
  • progress_rate number nullable
  • roe number nullable
  • roa number nullable
  • total_asset_turnover number nullable
  • free_cash_flow integer nullable
  • operating_cash_flow integer nullable
  • investing_cash_flow integer nullable
  • financing_cash_flow integer nullable
  • cash integer nullable
  • cash_ratio number nullable
  • bps number nullable
  • equity_ratio number nullable
  • total_assets integer nullable
  • equity integer nullable
  • retained_earnings integer nullable
  • debt_equity_ratio number nullable
  • announced_date integer nullable
• quarterly array (default: [])
  • @type string (default: "KabutanFinancialPeriod")
  • period string required
  • accounting_standard string nullable
  • is_forecast boolean (default: false)
  • revenue integer nullable
  • operating_profit integer nullable
  • ordinary_profit integer nullable
  • net_profit integer nullable
  • eps number nullable
  • dividend number nullable
  • operating_margin number nullable
  • progress_rate number nullable
  • roe number nullable
  • roa number nullable
  • total_asset_turnover number nullable
  • free_cash_flow integer nullable
  • operating_cash_flow integer nullable
  • investing_cash_flow integer nullable
  • financing_cash_flow integer nullable
  • cash integer nullable
  • cash_ratio number nullable
  • bps number nullable
  • equity_ratio number nullable
  • total_assets integer nullable
  • equity integer nullable
  • retained_earnings integer nullable
  • debt_equity_ratio number nullable
  • announced_date integer nullable
• cumulative_quarterly array (default: [])
  • @type string (default: "KabutanFinancialPeriod")
  • period string required
  • accounting_standard string nullable
  • is_forecast boolean (default: false)
  • revenue integer nullable
  • operating_profit integer nullable
  • ordinary_profit integer nullable
  • net_profit integer nullable
  • eps number nullable
  • dividend number nullable
  • operating_margin number nullable
  • progress_rate number nullable
  • roe number nullable
  • roa number nullable
  • total_asset_turnover number nullable
  • free_cash_flow integer nullable
  • operating_cash_flow integer nullable
  • investing_cash_flow integer nullable
  • financing_cash_flow integer nullable
  • cash integer nullable
  • cash_ratio number nullable
  • bps number nullable
  • equity_ratio number nullable
  • total_assets integer nullable
  • equity integer nullable
  • retained_earnings integer nullable
  • debt_equity_ratio number nullable
  • announced_date integer nullable
• profitability array (default: [])
  • @type string (default: "KabutanFinancialPeriod")
  • period string required
  • accounting_standard string nullable
  • is_forecast boolean (default: false)
  • revenue integer nullable
  • operating_profit integer nullable
  • ordinary_profit integer nullable
  • net_profit integer nullable
  • eps number nullable
  • dividend number nullable
  • operating_margin number nullable
  • progress_rate number nullable
  • roe number nullable
  • roa number nullable
  • total_asset_turnover number nullable
  • free_cash_flow integer nullable
  • operating_cash_flow integer nullable
  • investing_cash_flow integer nullable
  • financing_cash_flow integer nullable
  • cash integer nullable
  • cash_ratio number nullable
  • bps number nullable
  • equity_ratio number nullable
  • total_assets integer nullable
  • equity integer nullable
  • retained_earnings integer nullable
  • debt_equity_ratio number nullable
  • announced_date integer nullable
• cash_flow array (default: [])
  • @type string (default: "KabutanFinancialPeriod")
  • period string required
  • accounting_standard string nullable
  • is_forecast boolean (default: false)
  • revenue integer nullable
  • operating_profit integer nullable
  • ordinary_profit integer nullable
  • net_profit integer nullable
  • eps number nullable
  • dividend number nullable
  • operating_margin number nullable
  • progress_rate number nullable
  • roe number nullable
  • roa number nullable
  • total_asset_turnover number nullable
  • free_cash_flow integer nullable
  • operating_cash_flow integer nullable
  • investing_cash_flow integer nullable
  • financing_cash_flow integer nullable
  • cash integer nullable
  • cash_ratio number nullable
  • bps number nullable
  • equity_ratio number nullable
  • total_assets integer nullable
  • equity integer nullable
  • retained_earnings integer nullable
  • debt_equity_ratio number nullable
  • announced_date integer nullable
• balance_sheet array (default: [])
  • @type string (default: "KabutanFinancialPeriod")
  • period string required
  • accounting_standard string nullable
  • is_forecast boolean (default: false)
  • revenue integer nullable
  • operating_profit integer nullable
  • ordinary_profit integer nullable
  • net_profit integer nullable
  • eps number nullable
  • dividend number nullable
  • operating_margin number nullable
  • progress_rate number nullable
  • roe number nullable
  • roa number nullable
  • total_asset_turnover number nullable
  • free_cash_flow integer nullable
  • operating_cash_flow integer nullable
  • investing_cash_flow integer nullable
  • financing_cash_flow integer nullable
  • cash integer nullable
  • cash_ratio number nullable
  • bps number nullable
  • equity_ratio number nullable
  • total_assets integer nullable
  • equity integer nullable
  • retained_earnings integer nullable
  • debt_equity_ratio number nullable
  • announced_date 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.