/finviz/screener

POST /api/finviz/screener

Price: 10 credits

Screen stocks by exchange, index, sector, market cap, recommendation, dividend yield, and price

How to use it

Screen the full stock listing by filters: exchange, index membership, sector, market cap tier, analyst recommendation, dividend yield, and price range. All filters are optional and combine with AND. Each matching stock includes profile (name, sector, industry, country, exchange, index), valuation multiples, EPS and sales growth, margins, ownership, short interest, dividends, performance over multiple horizons, technicals (volatility, SMA, 50D/52W distance), OHLC price and volume, plus ETF metrics (AUM, holdings, expense, flows, returns) when applicable. Results are ordered by market cap, largest first. Percentage fields are decimals.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• exchange string nullable — Filter by listing exchange (one of: "amex", "cboe", "nasd", "nyse")
• index string nullable — Filter by membership in a major index (one of: "sp500", "ndx", "dji", "rut")
• sector string nullable — Filter by sector (one of: "basicmaterials", "communicationservices", "consumercyclical", "consumerdefensive", "energy", "financial", "healthcare", "industrials", "realestate", "technology", "utilities")
• market_cap string nullable — Filter by market capitalization tier (one of: "mega", "large", "mid", "small", "micro", "nano")
• recommendation string nullable — Filter by analyst recommendation (one of: "strong_buy", "buy", "hold", "sell", "strong_sell")
• dividend_yield string nullable — Filter by dividend yield (one of: "none", "positive", "high", "very_high", "over_1", "over_2", "over_3", "over_5")
• price string nullable — Filter by share price range (one of: "under_5", "under_10", "under_20", "under_50", "over_5", "over_10", "over_20", "over_50")
• count integer required — Maximum number of stocks to return (min: 1)

Response

• @type string (default: "FinvizScreenerStock")
• id string required
• name string nullable
• sector string nullable
• industry string nullable
• country string nullable
• exchange string nullable
• index string nullable
• price number nullable
• prev_close number nullable
• open number nullable
• high number nullable
• low number nullable
• change_percent number nullable
• target_price number nullable
• market_cap number nullable
• enterprise_value number nullable
• income number nullable
• sales number nullable
• pe number nullable
• forward_pe number nullable
• peg number nullable
• ps number nullable
• pb number nullable
• pc number nullable
• pfcf number nullable
• ev_ebitda number nullable
• ev_sales number nullable
• book_per_share number nullable
• cash_per_share number nullable
• dividend_ttm number nullable
• dividend_est number nullable
• dividend_est_yield_percent number nullable
• dividend_ex_date string nullable
• dividend_growth_1y_percent number nullable
• dividend_growth_3y_percent number nullable
• dividend_growth_5y_percent number nullable
• payout_percent number nullable
• eps_ttm number nullable
• eps_next_q number nullable
• eps_this_y_percent number nullable
• eps_next_y_percent number nullable
• eps_past_3y_percent number nullable
• eps_past_5y_percent number nullable
• eps_next_5y_percent number nullable
• eps_qoq_percent number nullable
• eps_yoy_ttm_percent number nullable
• eps_surprise_percent number nullable
• sales_past_3y_percent number nullable
• sales_past_5y_percent number nullable
• sales_qoq_percent number nullable
• sales_yoy_ttm_percent number nullable
• sales_surprise_percent number nullable
• shares_outstanding number nullable
• shares_float number nullable
• float_percent number nullable
• insider_own_percent number nullable
• insider_trans_percent number nullable
• inst_own_percent number nullable
• inst_trans_percent number nullable
• short_float_percent number nullable
• short_ratio number nullable
• short_interest number nullable
• roa_percent number nullable
• roe_percent number nullable
• roic_percent number nullable
• current_ratio number nullable
• quick_ratio number nullable
• debt_eq number nullable
• lt_debt_eq number nullable
• gross_margin_percent number nullable
• operating_margin_percent number nullable
• profit_margin_percent number nullable
• perf_week_percent number nullable
• perf_month_percent number nullable
• perf_quarter_percent number nullable
• perf_half_year_percent number nullable
• perf_year_percent number nullable
• perf_ytd_percent number nullable
• perf_3y_percent number nullable
• perf_5y_percent number nullable
• perf_10y_percent number nullable
• beta number nullable
• atr number nullable
• rsi number nullable
• volatility_week_percent number nullable
• volatility_month_percent number nullable
• sma20_percent number nullable
• sma50_percent number nullable
• sma200_percent number nullable
• high_50d_percent number nullable
• low_50d_percent number nullable
• high_52w_percent number nullable
• low_52w_percent number nullable
• all_time_high_percent number nullable
• all_time_low_percent number nullable
• change_from_open_percent number nullable
• gap_percent number nullable
• recommendation number nullable
• avg_volume number nullable
• rel_volume number nullable
• volume integer nullable
• employee_count integer nullable
• earnings string nullable
• ipo_date string nullable
• asset_type string nullable
• holdings_count integer nullable
• aum number nullable
• expense_percent number nullable
• flows_1m number nullable
• flows_1m_percent number nullable
• flows_3m number nullable
• flows_3m_percent number nullable
• flows_ytd number nullable
• flows_ytd_percent number nullable
• return_1y_percent number nullable
• return_3y_percent number nullable
• return_5y_percent number 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.