Skip to content
Clear Street Clear Street
Start Trading
API Reference
V1
Screener

Get Screeners

v1.screener.get_screeners() -> ScreenerGetScreenersResponse
GET/v1/saved-screeners

List saved screener configurations.

Returns all screener configurations for the authenticated user.

ReturnsExpand Collapse
class ScreenerGetScreenersResponse: …
id: str
created_at: datetime
filters: List[SearchFilter]
left: FieldRef

The field to filter on.

name: str

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]

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

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[List[OperatorArg]]

Optional arguments that modify operator behavior.

One of the following:
"LEFT_INCLUSIVE"
"RIGHT_INCLUSIVE"
"LEFT_EXCLUSIVE"
"RIGHT_EXCLUSIVE"
"CASE_INSENSITIVE"
right: Optional[List[FilterValue]]

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

value: Optional[Union[float, str, null]]
One of the following:
float
str
variable: Optional[Variable]

A variable reference.

name: str

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]

Optional arithmetic modifier.

args: List[Union[float, str]]
One of the following:
float
str

The modifier operation.

One of the following:
"ADD"
"SUBTRACT"
period: Optional[FieldPeriod]

Optional reporting period.

One of the following:
"QUARTER"
"TRAILING_TWELVE_MONTHS"
name: str
updated_at: datetime
columns: Optional[List[FieldRef]]

Field references included when running this screener.

name: str

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[List[FieldRef]]

Deprecated: use columns instead. Mirrors columns.

name: str

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[List[SortSpec]]
field: FieldRef

The field to sort by.

name: str

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

from clearstreet import ClearStreet

client = ClearStreet(
    api_key="My API Key",
)
response = client.v1.screener.get_screeners()
print(response)
{
  "data": [
    {
      "created_at": "2026-03-20T14:30:00Z",
      "filters": [
        {
          "left": {
            "name": "market_cap"
          },
          "op": {
            "name": "GTE"
          },
          "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": "GTE"
          },
          "right": [
            {
              "value": 10000000
            }
          ]
        }
      ],
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "High Volume",
      "updated_at": "2026-03-21T09:00:00Z"
    }
  ],
  "error": null,
  "metadata": {
    "request_id": "1a2b3c4d-5e6f-7890-1234-5a6b7c8d9e0f"
  }
}
Returns Examples
{
  "data": [
    {
      "created_at": "2026-03-20T14:30:00Z",
      "filters": [
        {
          "left": {
            "name": "market_cap"
          },
          "op": {
            "name": "GTE"
          },
          "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": "GTE"
          },
          "right": [
            {
              "value": 10000000
            }
          ]
        }
      ],
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "High Volume",
      "updated_at": "2026-03-21T09:00:00Z"
    }
  ],
  "error": null,
  "metadata": {
    "request_id": "1a2b3c4d-5e6f-7890-1234-5a6b7c8d9e0f"
  }
}