/tradingview/screener

POST /api/tradingview/screener

Price: 1 credit

Screen instruments by exchange, sector, analyst rating, and fundamental ranges

How to use it

Screen instruments across a market region by filters: exchange (NASDAQ/NYSE/AMEX/OTC), sector, analyst rating, and numeric ranges for market cap, price, P/E, and dividend yield. Sort by market cap, volume, change, price, P/E, or dividend yield. Returns symbol, name, price, change, volume, market cap, P/E, EPS, dividend yield, sector, industry, country, exchange, analyst rating, and technical rating.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• region string — Market region to screen (default: "america"; one of: "america", "australia", "canada", "germany", "india", "uk")
• exchange string nullable — Filter by listing exchange (one of: "NASDAQ", "NYSE", "AMEX", "OTC")
• sector string nullable — Filter by sector (examples: "Technology Services", "Finance", "Health Technology")
• analyst_rating string nullable — Filter by analyst rating (one of: "StrongBuy", "Buy", "Neutral", "Sell", "StrongSell")
• min_market_cap number nullable — Minimum market capitalization (min: 0)
• max_market_cap number nullable — Maximum market capitalization (min: 0)
• min_price number nullable — Minimum last price (min: 0)
• max_price number nullable — Maximum last price (min: 0)
• min_price_earnings number nullable — Minimum trailing P/E ratio
• max_price_earnings number nullable — Maximum trailing P/E ratio
• min_dividend_yield number nullable — Minimum dividend yield percent (min: 0)
• sort_by string — Field to sort by (default: "market_cap"; one of: "market_cap", "volume", "change", "price", "price_earnings", "dividend_yield")
• sort_order string — Sort direction (default: "desc"; one of: "asc", "desc")
• count integer required — Maximum number of instruments to return (min: 1)

Response

• @type string (default: "TradingViewScreenerStock")
• symbol string required
• name string nullable
• description string nullable
• image string nullable
• close number nullable
• change number nullable
• change_abs number nullable
• volume number nullable
• market_cap number nullable
• price_earnings_ttm number nullable
• earnings_per_share_ttm number nullable
• dividend_yield number nullable
• sector string nullable
• industry string nullable
• country string nullable
• exchange string nullable
• currency string nullable
• analyst_rating string nullable
• technical_rating number nullable
• type string nullable
• typespecs array (default: [])

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.