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

Get Screeners

ScreenerGetScreenersResponse v1().screener().getScreeners(ScreenerGetScreenersParamsparams = ScreenerGetScreenersParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/saved-screeners

List saved screener configurations.

Returns all screener configurations for the authenticated user.

ParametersExpand Collapse
ScreenerGetScreenersParams params
ReturnsExpand Collapse
class ScreenerGetScreenersResponse:
List<ScreenerEntry> data
String id
LocalDateTime createdAt
List<SearchFilter> filters

The field to filter on.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:
ONE_DAY("ONE_DAY")
ONE_WEEK("ONE_WEEK")
ONE_MONTH("ONE_MONTH")
THREE_MONTHS("THREE_MONTHS")
SIX_MONTHS("SIX_MONTHS")
YEAR_TO_DATE("YEAR_TO_DATE")
ONE_YEAR("ONE_YEAR")
Optional<FieldPeriod> period

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

One of the following:
QUARTER("QUARTER")
TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")
Optional<FieldType> valueType

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

One of the following:
DECIMAL("DECIMAL")
INTEGER("INTEGER")
STRING("STRING")
ANALYST_RATING("ANALYST_RATING")
DATE("DATE")
Optional<FilterOpSpec> op

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

The operator to apply.

One of the following:
LESS_THAN("LESS_THAN")
LESS_OR_EQUAL("LESS_OR_EQUAL")
GREATER_THAN("GREATER_THAN")
GREATER_OR_EQUAL("GREATER_OR_EQUAL")
EQUAL("EQUAL")
BETWEEN("BETWEEN")
NOT_BETWEEN("NOT_BETWEEN")
ONE_OF("ONE_OF")
REGEX("REGEX")
BEGINS_WITH("BEGINS_WITH")
ENDS_WITH("ENDS_WITH")
CONTAINS("CONTAINS")
IS_NULL("IS_NULL")
IS_NOT_NULL("IS_NOT_NULL")
Optional<List<OperatorArg>> args

Optional arguments that modify operator behavior.

One of the following:
LEFT_INCLUSIVE("LEFT_INCLUSIVE")
RIGHT_INCLUSIVE("RIGHT_INCLUSIVE")
LEFT_EXCLUSIVE("LEFT_EXCLUSIVE")
RIGHT_EXCLUSIVE("RIGHT_EXCLUSIVE")
CASE_INSENSITIVE("CASE_INSENSITIVE")
Optional<List<FilterValue>> right

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

Optional<Value> value
One of the following:
double
String
Optional<Variable> variable

A variable reference.

String name

The variable name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:
ONE_DAY("ONE_DAY")
ONE_WEEK("ONE_WEEK")
ONE_MONTH("ONE_MONTH")
THREE_MONTHS("THREE_MONTHS")
SIX_MONTHS("SIX_MONTHS")
YEAR_TO_DATE("YEAR_TO_DATE")
ONE_YEAR("ONE_YEAR")
Optional<Modifier> modifier

Optional arithmetic modifier.

List<Arg> args
One of the following:
double
String

The modifier operation.

One of the following:
ADD("ADD")
SUBTRACT("SUBTRACT")
Optional<FieldPeriod> period

Optional reporting period.

One of the following:
QUARTER("QUARTER")
TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")
String name
LocalDateTime updatedAt
Optional<List<FieldRef>> columns

Field references included when running this screener.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:
ONE_DAY("ONE_DAY")
ONE_WEEK("ONE_WEEK")
ONE_MONTH("ONE_MONTH")
THREE_MONTHS("THREE_MONTHS")
SIX_MONTHS("SIX_MONTHS")
YEAR_TO_DATE("YEAR_TO_DATE")
ONE_YEAR("ONE_YEAR")
Optional<FieldPeriod> period

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

One of the following:
QUARTER("QUARTER")
TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")
Optional<FieldType> valueType

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

One of the following:
DECIMAL("DECIMAL")
INTEGER("INTEGER")
STRING("STRING")
ANALYST_RATING("ANALYST_RATING")
DATE("DATE")
DeprecatedOptional<List<FieldRef>> fieldFilter

Deprecated: use columns instead. Mirrors columns.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:
ONE_DAY("ONE_DAY")
ONE_WEEK("ONE_WEEK")
ONE_MONTH("ONE_MONTH")
THREE_MONTHS("THREE_MONTHS")
SIX_MONTHS("SIX_MONTHS")
YEAR_TO_DATE("YEAR_TO_DATE")
ONE_YEAR("ONE_YEAR")
Optional<FieldPeriod> period

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

One of the following:
QUARTER("QUARTER")
TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")
Optional<FieldType> valueType

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

One of the following:
DECIMAL("DECIMAL")
INTEGER("INTEGER")
STRING("STRING")
ANALYST_RATING("ANALYST_RATING")
DATE("DATE")
Optional<List<SortSpec>> sorts
FieldRef field

The field to sort by.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:
ONE_DAY("ONE_DAY")
ONE_WEEK("ONE_WEEK")
ONE_MONTH("ONE_MONTH")
THREE_MONTHS("THREE_MONTHS")
SIX_MONTHS("SIX_MONTHS")
YEAR_TO_DATE("YEAR_TO_DATE")
ONE_YEAR("ONE_YEAR")
Optional<FieldPeriod> period

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

One of the following:
QUARTER("QUARTER")
TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")
Optional<FieldType> valueType

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

One of the following:
DECIMAL("DECIMAL")
INTEGER("INTEGER")
STRING("STRING")
ANALYST_RATING("ANALYST_RATING")
DATE("DATE")
Optional<SortDirection> direction

Sort direction (defaults to DESC).

One of the following:
ASC("ASC")
DESC("DESC")

Get Screeners

package com.clearstreet.api.example;

import com.clearstreet.api.client.ClearStreetClient;
import com.clearstreet.api.client.okhttp.ClearStreetOkHttpClient;
import com.clearstreet.api.models.v1.screener.ScreenerGetScreenersParams;
import com.clearstreet.api.models.v1.screener.ScreenerGetScreenersResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        ScreenerGetScreenersResponse response = client.v1().screener().getScreeners();
    }
}
{
  "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"
  }
}