/kabutan/screens

POST /api/kabutan/screens

Price: 5 credits

Run a predefined Kabutan stock screen — earnings upside, record profits, profit growth, high ROE, moving-average trends and crosses, volume surges, Ichimoku, parabolic, three-line break, RSI and MACD signals: code, name, market, price, change, PER, PBR, dividend yield and the screen's own columns

How to use it

Rows come in the screen's own order. Columns specific to a screen are in metrics with their label.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• screen string required — Predefined fundamental or technical screen (one of: "q1_half_year_upside", "q1_full_year_upside", "half_year_full_year_upside", "q3_full_year_upside", "record_profit_growth_top100", "consecutive_record_profit", "record_profit_comeback", "operating_profit_growth_top100", "high_roe_top100", "improving_roe", "golden_cross_5_25", "ma_uptrend", "below_ma25_by_10_percent", "dead_cross_5_25", "ma_downtrend", "above_ma25_by_10_percent", "volume_surge", "ichimoku_bullish", "ichimoku_bearish", "parabolic_buy", "parabolic_sell", "three_line_break_buy", "three_line_break_sell", "rsi_below_20", "rsi_above_80", "macd_buy", "macd_sell")
• market string — TSE market segment (default: "all"; one of: "all", "prime", "standard", "growth")
• count integer required — Max number of results (min: 1; max: 1000)

Response

• @type string (default: "KabutanStockRow")
• code string required
• name string required
• url string required
• market string nullable
• price number nullable
• price_mark string nullable
• change number nullable
• change_percent number nullable
• volume integer nullable
• per number nullable
• pbr number nullable
• dividend_yield number nullable
• margin_ratio number nullable
• news_url string nullable
• metrics array (default: [])
  • @type string (default: "KabutanMetric")
  • label string required
  • value string required

Errors

• 422 — The request body did not validate 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 — The entity was not found, or a precondition failed 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.