/minkabu/stocks/search

POST /api/minkabu/stocks/search

Price: 5 credits

Screen Japanese listed stocks on Minkabu by market, industry, valuation, dividend, profitability, growth, price change and perks, returning the results, target-price, analyst, AI and member ratings: price, change, market cap, PER, PBR, PSR, ROE, ROA, EPS, BPS, dividend data, revenue and profits, the four target prices with their ratings and one-month changes, prediction counts and listing date

How to use it

Without filters every listed stock and fund is screened. Ratings come as Minkabu's Japanese labels (買, 売, 割安, 割高).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• markets array nullable — TSE market segments (one of: "prime", "standard", "growth", "funds", "other"; examples: ["prime"])
• industries array nullable — TSE 33-sector industry codes (examples: ["3700"])
• ranges array nullable — Metric bounds; market_cap and minimum_purchase are in yen, ratios and changes in percent (examples: [{"max":10,"metric":"per"},{"metric":"dividend_yield","min":4}])
  • timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
  • metric string required — Metric to bound (one of: "market_cap", "minimum_purchase", "per", "pbr", "psr", "dividend_yield", "payout_ratio", "dps", "eps", "roe", "roa", "equity_ratio", "listing_year", "sales_cagr_3y", "operating_margin", "volume_change_percent", "perk_yield", "price_change_1d", "price_change_1w", "price_change_1m", "price_change_1y", "target_price_change_1m", "analyst_target_change_1m", "ai_fair_price_change_1m", "member_target_change_1m")
  • min number nullable — Lower bound, inclusive
  • max number nullable — Upper bound, inclusive
• has_perks boolean — Only stocks with shareholder perks (default: false)
• sort_by string — Sort key (default: "favorites"; one of: "favorites", "market_cap", "per", "pbr", "psr", "dividend_yield", "payout_ratio", "roe", "roa", "eps", "sales_cagr_3y", "operating_margin", "volume_change_percent", "price_change_1d", "price_change_1w", "price_change_1m", "price_change_1y")
• order string — Sort order (default: "desc"; one of: "desc", "asc")
• count integer required — Max number of results (min: 1; max: 2000)

Response

• @type string (default: "MinkabuScreenedStock")
• code string required
• name string nullable
• url string required
• market string nullable
• industry string nullable
• price number nullable
• price_date integer nullable
• change number nullable
• change_percent number nullable
• volume integer nullable
• volume_change_percent number nullable
• favorites integer nullable
• target_price number nullable
• target_price_rating string nullable
• analyst_target_price number nullable
• analyst_rating string nullable
• ai_fair_price number nullable
• ai_rating string nullable
• member_target_price number nullable
• member_rating string nullable
• buy_predictions integer nullable
• sell_predictions integer nullable
• target_price_change_1m number nullable
• analyst_target_change_1m number nullable
• ai_fair_price_change_1m number nullable
• member_target_change_1m number nullable
• price_change_1d number nullable
• price_change_1w number nullable
• price_change_1m number nullable
• price_change_1y number nullable
• minimum_purchase number nullable
• unit_shares integer nullable
• market_cap integer nullable
• per number nullable
• pbr number nullable
• psr number nullable
• roa number nullable
• roe number nullable
• eps number nullable
• bps number nullable
• dps number nullable
• dividend_yield number nullable
• payout_ratio number nullable
• consecutive_dividend_increases integer nullable
• has_perks boolean nullable
• perk_yield number nullable
• equity_ratio number nullable
• revenue integer nullable
• sales_cagr_3y number nullable
• operating_profit integer nullable
• operating_margin number nullable
• ordinary_profit integer nullable
• net_profit integer nullable
• net_assets integer nullable
• total_assets integer nullable
• capital integer nullable
• results_rating integer nullable
• listed_date integer nullable

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.