Browse the docs

Run a screen

GET/v1/screener

Run the equity screener on your own filters: the matching stocks with the columns the view names, at most limit of them, and how many matched in all. The screener filter list names every filter.

Each call counts against your allowance.

Parameters

NameInTypeWhat it does
filters (required)querylist, comma-separated, up to 20Filter tokens from the screener filter list, like cap_largeover and fa_pe_u20. One per filter.
signalqueryone of the valuesA screener signal, like ta_topgainers. One of ta_topgainers, ta_topgainers_1m, ta_topgainers_2m, ta_topgainers_3m, ta_topgainers_5m, ta_topgainers_10m, ta_topgainers_15m, ta_topgainers_30m, ta_topgainers_1h, ta_topgainers_2h, ta_topgainers_4h, ta_toplosers, ta_toplosers_1m, ta_toplosers_2m, ta_toplosers_3m, ta_toplosers_5m, ta_toplosers_10m, ta_toplosers_15m, ta_toplosers_30m, ta_toplosers_1h, ta_toplosers_2h, ta_toplosers_4h, ta_newhigh, ta_newlow, ta_mostvolatile, ta_mostactive, ta_unusualvolume, ta_overbought, ta_oversold, n_downgrades, n_upgrades, n_earningsbefore, n_earningsafter, it_latestbuys, it_latestsales, n_majornews, ta_p_horizontal, ta_p_tlresistance, ta_p_tlsupport, ta_p_wedgeup, ta_p_wedgedown, ta_p_wedgeresistance, ta_p_wedgesupport, ta_p_wedge, ta_p_channelup, ta_p_channeldown, ta_p_channel, ta_p_doubletop, ta_p_doublebottom, ta_p_multipletop, ta_p_multiplebottom, ta_p_headandshoulders, ta_p_headandshouldersinv, f_halted, f_ssr.
viewqueryone of the valuesWhich columns: search shows the figure each filter names; the others are the screener's fixed column sets. One of search, overview, valuation, ownership, performance, financial, technical. Leave it out for search.
limitquerywhole number, 1–500How many matching stocks. Leave it out for 100.

Any other parameter is refused, so a typo is caught rather than quietly ignored.

Answer

The answer is { data, asOf }. Here is data, abridged: real answers carry more fields.

data (abridged)
{
  "screen": null,
  "view": "search",
  "count": 212,
  "returned": 1,
  "truncated": true,
  "results": [
    {
      "ticker": "NVDA",
      "company": "NVIDIA Corp",
      "sector": "Technology",
      "marketCap": 4410000000000,
      "pe": 52.3,
      "price": 181.2,
      "change": 0.021
    }
  ]
}

Answers and errors covers every answer’s shape and what an error carries.