Skip to main content

Screeners

Use screeners to discover groups of securities such as day gainers, undervalued large caps, growth technology stocks, or other Yahoo Finance screener datasets.

Discover Available Screeners​

curl "https://api.yfin.dev/v1/screener_discover?region=US" \
  -H "X-Yfin-Contact: you@example.com"
const discover = await client.screenerDiscover({ region: "US" });

Run A Screen​

curl "https://api.yfin.dev/v1/screener?count=25&offset=0" \
  -H "X-Yfin-Contact: you@example.com"
import yfin

client = yfin.Client(contact="you@example.com")
screen = client.screener({"size": 25})
const screen = await client.screen({ size: 25 });

Combine With Quotes​

A common workflow is:

  1. Discover or run a screener.
  2. Extract symbols from the result.
  3. Call /v1/quote for the fields your UI needs.
const screen = await client.screen({ size: 10 });
const symbols = extractSymbols(screen);
const quotes = await client.quote(symbols);

Practical Rules​

  • Use count and offset for paginated screens when available.
  • Keep screener criteria visible in your UI so users know what they are seeing.
  • Quote screener symbols before displaying current prices.
  • Handle empty result sets as normal.