POST /api/yahoo/finance/screeners
Price: 5 credits
Get the results of a predefined Yahoo Finance screener: gainers, losers, most active, funds
Rows of a predefined Yahoo Finance screener of US securities, such as day_gainers, most_actives, undervalued_large_caps, top_mutual_funds or top_options_open_interest. Fund screeners add returns, ratings and expense ratios; the options screener adds the contract terms.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)screener string required — Predefined screener (one of: "day_gainers", "day_losers", "most_actives", "undervalued_growth_stocks", "growth_technology_stocks", "undervalued_large_caps", "aggressive_small_caps", "small_cap_gainers", "most_shorted_stocks", "top_mutual_funds", "portfolio_anchors", "solid_large_growth_funds", "solid_midcap_growth_funds", "conservative_foreign_funds", "high_yield_bond", "top_options_open_interest"; examples: "day_gainers", "top_mutual_funds")count integer required — Max number of results (min: 1; max: 1000)@type string (default: "YahooFinanceScreenerResult")symbol string requiredname string nullablescreener string requiredexchange string nullableregion string nullablesector string nullableindustry string nullableimage string nullableprice number nullablechange number nullablechange_percent number nullableopen number nullablevolume integer nullableaverage_volume_3_month number nullablemarket_cap number nullablefifty_two_week_low number nullablefifty_two_week_high number nullablefifty_two_week_change_percent number nullablefifty_day_average number nullabletwo_hundred_day_average number nullablepe_ratio number nullablepeg_ratio_5_year number nullableenterprise_value_to_ebit number nullableeps_growth_percent number nullablerevenue_growth_percent_quarterly number nullableinstitutions_percent_held number nullableaverage_rating string nullableindices array (default: [])fund_net_assets number nullablefund_category string nullablereturn_1_year number nullablereturn_1_year_category_rank integer nullablereturn_3_year number nullablereturn_5_year number nullablereturn_3_month number nullablereturn_ytd number nullableperformance_rating integer nullablerisk_rating integer nullablegross_expense_ratio number nullablenet_expense_ratio number nullableinitial_investment number nullableunderlying_symbol string nullableunderlying_name string nullablestrike number nullableexpiration_at integer nullablebid number nullableask number nullableopen_interest integer nullableimplied_volatility number nullable422 — 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.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-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.