## Create Screener `client.V1.Screener.NewScreener(ctx, body) (*V1ScreenerNewScreenerResponse, error)` **post** `/v1/saved-screeners` Create a saved screener configuration. Persists a screener configuration for the authenticated user. ### Parameters - `body V1ScreenerNewScreenerParams` - `Columns param.Field[[]FieldRef]` Structured field references to include when running this screener - `Name string` The field name. - `Lookback FieldLookback` Optional historical lookback window. - `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 FieldPeriod` Optional reporting period (e.g. quarter or TTM). - `const FieldPeriodQuarter FieldPeriod = "QUARTER"` - `const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"` - `ValueType FieldType` The data type of the field value. Present only in responses. - `const FieldTypeDecimal FieldType = "DECIMAL"` - `const FieldTypeInteger FieldType = "INTEGER"` - `const FieldTypeString FieldType = "STRING"` - `const FieldTypeAnalystRating FieldType = "ANALYST_RATING"` - `const FieldTypeDate FieldType = "DATE"` - `FieldFilter param.Field[[]FieldRef]` Deprecated: use `columns` instead. Ignored when `columns` is provided. - `Name string` The field name. - `Lookback FieldLookback` Optional historical lookback window. - `Period FieldPeriod` Optional reporting period (e.g. quarter or TTM). - `ValueType FieldType` The data type of the field value. Present only in responses. - `Filters param.Field[[]SearchFilter]` Structured search filter criteria - `Left FieldRef` The field to filter on. - `Name string` The field name. - `Lookback FieldLookback` Optional historical lookback window. - `Period FieldPeriod` Optional reporting period (e.g. quarter or TTM). - `ValueType FieldType` The data type of the field value. Present only in responses. - `Op FilterOpSpec` The operator and optional arguments. Omit together with `right` for an unenabled filter. - `Name FilterOperator` The operator to apply. - `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 []OperatorArg` Optional arguments that modify operator behavior. - `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 []FilterValue` The value(s) to compare against. Omit together with `op` for an unenabled filter. - `Value FilterValueValueUnion` - `float64` - `string` - `Variable Variable` A variable reference. - `Name string` The variable name. - `Lookback FieldLookback` Optional historical lookback window. - `Modifier Modifier` Optional arithmetic modifier. - `Args []ModifierArgUnion` - `float64` - `string` - `Name ModifierOp` The modifier operation. - `const ModifierOpAdd ModifierOp = "ADD"` - `const ModifierOpSubtract ModifierOp = "SUBTRACT"` - `Period FieldPeriod` Optional reporting period. - `Name param.Field[string]` The name for this screener configuration - `Sorts param.Field[[]SortSpec]` Multi-field sort specifications - `Field FieldRef` The field to sort by. - `Direction SortDirection` Sort direction (defaults to DESC). - `const SortDirectionAsc SortDirection = "ASC"` - `const SortDirectionDesc SortDirection = "DESC"` ### Returns - `type V1ScreenerNewScreenerResponse 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 FieldLookback` Optional historical lookback window. - `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 FieldPeriod` Optional reporting period (e.g. quarter or TTM). - `const FieldPeriodQuarter FieldPeriod = "QUARTER"` - `const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"` - `ValueType FieldType` The data type of the field value. Present only in responses. - `const FieldTypeDecimal FieldType = "DECIMAL"` - `const FieldTypeInteger FieldType = "INTEGER"` - `const FieldTypeString FieldType = "STRING"` - `const FieldTypeAnalystRating FieldType = "ANALYST_RATING"` - `const FieldTypeDate FieldType = "DATE"` - `Op FilterOpSpec` The operator and optional arguments. Omit together with `right` for an unenabled filter. - `Name FilterOperator` The operator to apply. - `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 []OperatorArg` Optional arguments that modify operator behavior. - `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 []FilterValue` The value(s) to compare against. Omit together with `op` for an unenabled filter. - `Value FilterValueValueUnion` - `float64` - `string` - `Variable Variable` A variable reference. - `Name string` The variable name. - `Lookback FieldLookback` Optional historical lookback window. - `Modifier Modifier` Optional arithmetic modifier. - `Args []ModifierArgUnion` - `float64` - `string` - `Name ModifierOp` The modifier operation. - `const ModifierOpAdd ModifierOp = "ADD"` - `const ModifierOpSubtract ModifierOp = "SUBTRACT"` - `Period FieldPeriod` Optional reporting period. - `Name string` - `UpdatedAt Time` - `Columns []FieldRef` Field references included when running this screener. - `Name string` The field name. - `Lookback FieldLookback` Optional historical lookback window. - `Period FieldPeriod` Optional reporting period (e.g. quarter or TTM). - `ValueType FieldType` The data type of the field value. Present only in responses. - `FieldFilter []FieldRef` Deprecated: use `columns` instead. Mirrors `columns`. - `Name string` The field name. - `Lookback FieldLookback` Optional historical lookback window. - `Period FieldPeriod` Optional reporting period (e.g. quarter or TTM). - `ValueType FieldType` The data type of the field value. Present only in responses. - `Sorts []SortSpec` - `Field FieldRef` The field to sort by. - `Direction SortDirection` Sort direction (defaults to DESC). - `const SortDirectionAsc SortDirection = "ASC"` - `const SortDirectionDesc SortDirection = "DESC"` ### Example ```go 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.NewScreener(context.TODO(), clearstreet.V1ScreenerNewScreenerParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response) } ``` #### Response ```json { "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" } } ```