Browse the docs

Screener filter list

GET/v1/screener/filters

Everything the equity screener can run: the ready-made screens and your saved screens (each with its id and filters), every filter as a token with its plain label, by family, and the signals. Read it before running a screen.

Each call counts against your allowance.

Answer

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

data (abridged)
{
  "screens": [
    {
      "id": "6710c0ffee0000000000ad01",
      "kind": "ready-made",
      "name": "Pre-Market Bullish Gappers",
      "description": "Mid-cap and larger ($2B+) stocks up 3%+ pre-market with elevated volume",
      "filters": [
        "cap_midover",
        "geo_usa",
        "sh_relvol_o2"
      ],
      "signal": null
    }
  ],
  "filters": [
    {
      "family": "cap",
      "label": "Market Cap",
      "group": "Descriptive",
      "options": [
        {
          "token": "cap_large",
          "label": "Large ($10B to $200B)"
        }
      ]
    }
  ],
  "signals": [
    {
      "token": "ta_topgainers",
      "label": "Today's top gainers"
    }
  ]
}

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