API Reference

V1

Screener

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Screeners

GET/v1/saved-screeners

List saved screener configurations.

Returns all screener configurations for the authenticated user.

ReturnsExpand Collapse

data: ScreenerEntryList { id, created_at, filters, 5 more }

id: string

created_at: string

filters: array of SearchFilter { left, op, right }

left: FieldRef { name, lookback, period, value_type }

The field to filter on.

name: string

The field name.

lookback: optional FieldLookback

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: optional FieldPeriod

Optional reporting period (e.g. quarter or TTM).

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

value_type: optional FieldType

The data type of the field value. Present only in responses.

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

op: optional FilterOpSpec { name, args }

The operator and optional arguments. Omit together with right for an unenabled filter.

name: FilterOperator

The operator to apply.

One of the following:

"LESS_THAN"

"LESS_OR_EQUAL"

"GREATER_THAN"

"GREATER_OR_EQUAL"

"EQUAL"

"BETWEEN"

"NOT_BETWEEN"

"ONE_OF"

"REGEX"

"BEGINS_WITH"

"ENDS_WITH"

"CONTAINS"

"IS_NULL"

"IS_NOT_NULL"

args: optional array of OperatorArg

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: optional array of FilterValue { value, variable }

The value(s) to compare against. Omit together with op for an unenabled filter.

value: optional number or string

One of the following:

number

string

variable: optional Variable { name, lookback, modifier, period }

A variable reference.

name: string

The variable name.

lookback: optional FieldLookback

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

modifier: optional Modifier { args, name }

Optional arithmetic modifier.

args: array of number or string

One of the following:

number

string

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

period: optional FieldPeriod

Optional reporting period.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

name: string

updated_at: string

columns: optional array of FieldRef { name, lookback, period, value_type }

Field references included when running this screener.

name: string

The field name.

lookback: optional FieldLookback

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: optional FieldPeriod

Optional reporting period (e.g. quarter or TTM).

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

value_type: optional FieldType

The data type of the field value. Present only in responses.

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

Deprecatedfield_filter: optional array of FieldRef { name, lookback, period, value_type }

Deprecated: use columns instead. Mirrors columns.

name: string

The field name.

lookback: optional FieldLookback

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: optional FieldPeriod

Optional reporting period (e.g. quarter or TTM).

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

value_type: optional FieldType

The data type of the field value. Present only in responses.

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

sorts: optional array of SortSpec { field, direction }

field: FieldRef { name, lookback, period, value_type }

The field to sort by.

name: string

The field name.

lookback: optional FieldLookback

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: optional FieldPeriod

Optional reporting period (e.g. quarter or TTM).

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

value_type: optional FieldType

The data type of the field value. Present only in responses.

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

direction: optional SortDirection

Sort direction (defaults to DESC).

One of the following:

"ASC"

"DESC"

Get Screeners

HTTP

HTTP

TypeScript

Python

Java

Go

CLI Tool

curl https://api.clearstreet.com/v1/saved-screeners \
    -H "Authorization: Bearer $API_KEY"

200 example

{
  "data": [
    {
      "created_at": "2026-03-20T14:30:00Z",
      "filters": [
        {
          "left": {
            "name": "market_cap"
          },
          "op": {
            "name": "GREATER_OR_EQUAL"
          },
          "right": [
            {
              "value": 1000000000
            }
          ]
        }
      ],
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Tech Large Caps",
      "sorts": [
        {
          "direction": "DESC",
          "field": {
            "name": "market_cap"
          }
        }
      ],
      "updated_at": "2026-03-20T14:30:00Z"
    },
    {
      "columns": [
        {
          "name": "symbol"
        },
        {
          "name": "price"
        },
        {
          "name": "volume"
        }
      ],
      "created_at": "2026-03-21T09:00:00Z",
      "filters": [
        {
          "left": {
            "name": "volume"
          },
          "op": {
            "name": "GREATER_OR_EQUAL"
          },
          "right": [
            {
              "value": 10000000
            }
          ]
        }
      ],
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "High Volume",
      "updated_at": "2026-03-21T09:00:00Z"
    }
  ],
  "metadata": {
    "request_id": "1a2b3c4d-5e6f-7890-1234-5a6b7c8d9e0f"
  }
}

Returns Examples

200 example

{
  "data": [
    {
      "created_at": "2026-03-20T14:30:00Z",
      "filters": [
        {
          "left": {
            "name": "market_cap"
          },
          "op": {
            "name": "GREATER_OR_EQUAL"
          },
          "right": [
            {
              "value": 1000000000
            }
          ]
        }
      ],
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Tech Large Caps",
      "sorts": [
        {
          "direction": "DESC",
          "field": {
            "name": "market_cap"
          }
        }
      ],
      "updated_at": "2026-03-20T14:30:00Z"
    },
    {
      "columns": [
        {
          "name": "symbol"
        },
        {
          "name": "price"
        },
        {
          "name": "volume"
        }
      ],
      "created_at": "2026-03-21T09:00:00Z",
      "filters": [
        {
          "left": {
            "name": "volume"
          },
          "op": {
            "name": "GREATER_OR_EQUAL"
          },
          "right": [
            {
              "value": 10000000
            }
          ]
        }
      ],
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "High Volume",
      "updated_at": "2026-03-21T09:00:00Z"
    }
  ],
  "metadata": {
    "request_id": "1a2b3c4d-5e6f-7890-1234-5a6b7c8d9e0f"
  }
}