/toyokeizai/shikiho/stocks

POST /api/toyokeizai/shikiho/stocks

Price: 1 credit

Get a Japanese listed stock from Kaisha Shikiho Online by TSE code: names, market, sectors, Shikiho feature and business mix, Toyo Keizai scores, quote, valuation (PER, PBR, dividend yield, market cap), trading data, results and dividend tables with forecasts, peers and rivals, industries, themes, address, employees and corporate history

How to use it

Use toyokeizai/shikiho/stocks/news for the stock's disclosures and news.

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 Shikiho stock URL (examples: "7203", "130A", "https://shikiho.toyokeizai.net/stocks/6758")

Response

• @type string (default: "ToyokeizaiShikihoStock")
• code string required
• url string required
• asset_type string nullable
• name string nullable
• name_short string nullable
• name_medium string nullable
• name_kana string nullable
• name_en string nullable
• registered_name string nullable
• former_name string nullable
• market string nullable
• exchanges array (default: [])
• sector_33_code string nullable
• sector_33_ric string nullable
• sector_33_name string nullable
• tk_sector_code string nullable
• tk_sector_name string nullable
• tk_sector_small_code string nullable
• tk_sector_small_name string nullable
• margin_trading string nullable
• is_nikkei225 boolean nullable
• website string nullable
• feature string nullable
• businesses string nullable
• employees string nullable
• address string nullable
• map_address string nullable
• fiscal_year_end string nullable
• established_at integer nullable
• listed_at integer nullable
• delisted_at integer nullable
• last_disclosure_at integer nullable
• last_disclosure_period_end integer nullable
• planned_disclosure string nullable
• planned_disclosure_period_end integer nullable
• shikiho_issue string nullable
• shikiho_year integer nullable
• shikiho_season integer nullable
• shikiho_season_name string nullable
• shikiho_published_at integer nullable
• forecast_modified_at integer nullable
• score object nullable
  • @type string (default: "ToyokeizaiShikihoScore")
  • total integer nullable
  • profitability integer nullable
  • growth_potential integer nullable
  • reasonability integer nullable
  • market_size integer nullable
  • stability integer nullable
  • increase integer nullable
• quote object nullable
  • @type string (default: "ToyokeizaiShikihoQuote")
  • price number nullable
  • change number nullable
  • change_percent number nullable
  • updated_at integer nullable
  • open number nullable
  • open_at integer nullable
  • high number nullable
  • high_at integer nullable
  • low number nullable
  • low_at integer nullable
  • previous_close number nullable
  • previous_close_at integer nullable
  • limit_up number nullable
  • limit_down number nullable
• year_high number nullable
• year_high_at integer nullable
• year_low number nullable
• year_low_at integer nullable
• last_year_high number nullable
• last_year_low number nullable
• return_ytd number nullable
• ratio_to_200d_ma number nullable
• market_cap_million_yen number nullable
• minimum_purchase_amount number nullable
• trading_unit integer nullable
• volume number nullable
• trading_value_thousand_yen number nullable
• average_trading_value_22d number nullable
• per_forecast number nullable
• per_next_forecast number nullable
• pbr number nullable
• dividend_yield_forecast number nullable
• dividend_yield_next_forecast number nullable
• forecast_fiscal_year_end string nullable
• forecast_accounting_standard string nullable
• forecast_consolidation string nullable
• next_forecast_fiscal_year_end string nullable
• next_forecast_accounting_standard string nullable
• next_forecast_consolidation string nullable
• treasury_stock_ratio number nullable
• outstanding_shares number nullable
• shareholders_research_at integer nullable
• bps array (default: [])
• bps_yen number nullable
• fund_type string nullable
• management_company string nullable
• issuer string nullable
• reit_record_period string nullable
• results array (default: [])
  • @type string (default: "ToyokeizaiShikihoResultRow")
  • period string required
  • metrics array (default: [])
    • @type string (default: "ToyokeizaiShikihoMetric")
    • label string required
    • value number nullable
    • text string nullable
• dividends array (default: [])
  • @type string (default: "ToyokeizaiShikihoResultRow")
  • period string required
  • metrics array (default: [])
    • @type string (default: "ToyokeizaiShikihoMetric")
    • label string required
    • value number nullable
    • text string nullable
• peers array (default: [])
  • @type string (default: "ToyokeizaiShikihoPeer")
  • code string required
  • name string nullable
• rivals array (default: [])
  • @type string (default: "ToyokeizaiShikihoRival")
  • code string required
  • name string nullable
  • name_short string nullable
  • sector_code string nullable
  • sector_name string nullable
  • price number nullable
  • change number nullable
  • change_percent number nullable
  • price_updated_at integer nullable
  • net_sales_million_yen number nullable
  • operating_income_million_yen number nullable
  • operating_margin number nullable
  • net_income_million_yen number nullable
  • net_margin number nullable
  • roe_forecast number nullable
  • equity_ratio number nullable
  • per_forecast number nullable
  • pbr number nullable
  • psr number nullable
  • dividend_yield_forecast number nullable
  • yield_spread number nullable
  • market_cap_million_yen number nullable
  • score object nullable
    • @type string (default: "ToyokeizaiShikihoScore")
    • total integer nullable
    • profitability integer nullable
    • growth_potential integer nullable
    • reasonability integer nullable
    • market_size integer nullable
    • stability integer nullable
    • increase integer nullable
• industries array (default: [])
  • @type string (default: "ToyokeizaiShikihoIndustry")
  • code string nullable
  • name string required
  • short_name string nullable
• themes array (default: [])
• history array (default: [])
  • @type string (default: "ToyokeizaiShikihoHistoryEvent")
  • year_month string nullable
  • content 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 Kaisha Shikiho 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.