API Reference

V1

Screener

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Screener By ID

client.V1.Screener.GetScreenerByID(ctx, screenerID) (*V1ScreenerGetScreenerByIDResponse, error)

GET/v1/saved-screeners/{screener_id}

Get a saved screener configuration by ID.

Returns a single screener configuration for the authenticated user.

ParametersExpand Collapse

screenerID string

ReturnsExpand Collapse

type V1ScreenerGetScreenerByIDResponse struct{…}

Data ScreenerEntry

A saved screener configuration entry

ID string

CreatedAt Time

Filters []SearchFilter

Left FieldRef

The field to filter on.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Op FilterOpSpecOptional

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

Name FilterOperator

The operator to apply.

One of the following:

const FilterOperatorLessThan FilterOperator = "LESS_THAN"

const FilterOperatorLessOrEqual FilterOperator = "LESS_OR_EQUAL"

const FilterOperatorGreaterThan FilterOperator = "GREATER_THAN"

const FilterOperatorGreaterOrEqual FilterOperator = "GREATER_OR_EQUAL"

const FilterOperatorEqual FilterOperator = "EQUAL"

const FilterOperatorBetween FilterOperator = "BETWEEN"

const FilterOperatorNotBetween FilterOperator = "NOT_BETWEEN"

const FilterOperatorOneOf FilterOperator = "ONE_OF"

const FilterOperatorRegex FilterOperator = "REGEX"

const FilterOperatorBeginsWith FilterOperator = "BEGINS_WITH"

const FilterOperatorEndsWith FilterOperator = "ENDS_WITH"

const FilterOperatorContains FilterOperator = "CONTAINS"

const FilterOperatorIsNull FilterOperator = "IS_NULL"

const FilterOperatorIsNotNull FilterOperator = "IS_NOT_NULL"

Args []OperatorArgOptional

Optional arguments that modify operator behavior.

One of the following:

const OperatorArgLeftInclusive OperatorArg = "LEFT_INCLUSIVE"

const OperatorArgRightInclusive OperatorArg = "RIGHT_INCLUSIVE"

const OperatorArgLeftExclusive OperatorArg = "LEFT_EXCLUSIVE"

const OperatorArgRightExclusive OperatorArg = "RIGHT_EXCLUSIVE"

const OperatorArgCaseInsensitive OperatorArg = "CASE_INSENSITIVE"

Right []FilterValueOptional

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

Value FilterValueValueUnionOptional

One of the following:

float64

string

Variable VariableOptional

A variable reference.

Name string

The variable name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Modifier ModifierOptional

Optional arithmetic modifier.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

Period FieldPeriodOptional

Optional reporting period.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

Name string

UpdatedAt Time

Columns []FieldRefOptional

Field references included when running this screener.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

DeprecatedFieldFilter []FieldRefOptional

Deprecated: use columns instead. Mirrors columns.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Sorts []SortSpecOptional

Field FieldRef

The field to sort by.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Direction SortDirectionOptional

Sort direction (defaults to DESC).

One of the following:

const SortDirectionAsc SortDirection = "ASC"

const SortDirectionDesc SortDirection = "DESC"

Get Screener By ID

Go

HTTP

TypeScript

Python

Java

Go

CLI Tool

package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.Screener.GetScreenerByID(context.TODO(), "550e8400-e29b-41d4-a716-446655440000")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}

200 example

400 example

404 example

{
  "data": {
    "columns": [
      {
        "name": "symbol"
      },
      {
        "name": "price"
      },
      {
        "name": "market_cap"
      }
    ],
    "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"
  },
  "metadata": {
    "request_id": "1a2b3c4d-5e6f-7890-1234-5a6b7c8d9e0f"
  }
}

{
  "error": {
    "code": 400,
    "message": "Cannot parse `screener_id` with value `123`: UUID parsing failed: invalid length: expected length 32 for simple format, found 3"
  },
  "metadata": {
    "request_id": "1940e272-8ce1-41bf-ad3e-7e2a9fd9c4df"
  }
}

{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "cb63a84c-6b39-4c37-bfdd-588b8256c7ea"
  }
}

Returns Examples

200 example

400 example

404 example

{
  "data": {
    "columns": [
      {
        "name": "symbol"
      },
      {
        "name": "price"
      },
      {
        "name": "market_cap"
      }
    ],
    "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"
  },
  "metadata": {
    "request_id": "1a2b3c4d-5e6f-7890-1234-5a6b7c8d9e0f"
  }
}

{
  "error": {
    "code": 400,
    "message": "Cannot parse `screener_id` with value `123`: UUID parsing failed: invalid length: expected length 32 for simple format, found 3"
  },
  "metadata": {
    "request_id": "1940e272-8ce1-41bf-ad3e-7e2a9fd9c4df"
  }
}

{
  "error": {
    "code": 404,
    "message": "Some requested entity was not found"
  },
  "metadata": {
    "request_id": "cb63a84c-6b39-4c37-bfdd-588b8256c7ea"
  }
}