Browse the docs

Run a saved screen

GET/v1/screener/screens/{id}

Run one of the screener's ready-made screens, or one of your saved screens, by its id from the screener filter list: the matching stocks, answered the way a screen of your own filters is.

Each call counts against your allowance.

Parameters

NameInTypeWhat it does
id (required)pathidThe screen's id, from the screener filter list.
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": {
    "id": "6710c0ffee0000000000ad01",
    "name": "Pre-Market Bullish Gappers"
  },
  "view": "search",
  "count": 14,
  "returned": 14,
  "truncated": false,
  "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.