# Screener ## Search Screener `client.V1.Screener.SearchScreener(ctx, body) (*V1ScreenerSearchScreenerResponse, error)` **post** `/v1/screener` Search instruments using structured filters. Returns a columnar response where each row is an array of column objects. Each column contains a human-readable name, a field reference, an optional type hint (e.g. `CURR_USD`, `PERCENT`), and the value. Use `columns` to select which columns appear in each row. When omitted, the default field set is returned. ### Parameters - `body V1ScreenerSearchScreenerParams` - `Columns param.Field[[]FieldRef]` Subset of fields to include in the response. - `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]` Filter conditions to apply. - `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. - `PageSize param.Field[int64]` The number of items to return per page (only used when page_token is not provided) - `PageToken param.Field[string]` Token for retrieving the next page of results. Contains encoded pagination state (limit + offset). When provided, page_size is ignored. - `SortCaseSensitive param.Field[bool]` Whether string sorts should be case-sensitive (default: false). - `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 V1ScreenerSearchScreenerResponse struct{…}` - `Data ScreenerRowList` - `Field FieldRef` Field reference (same shape as filter/sort field references) - `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"` - `Name string` Human-readable display name for this field - `Value ScreenerColumnValueUnion` - `float64` - `string` - `Type string` Value format hint: "CURR_USD", "PERCENT", etc. Omitted when not applicable. When a null/undefined value is observed, it indicates it does not apply. ### 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.SearchScreener(context.TODO(), clearstreet.V1ScreenerSearchScreenerParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response) } ``` #### Response ```json { "data": [ [ { "field": { "name": "symbol" }, "name": "Symbol", "value": "AAPL" }, { "field": { "name": "price" }, "name": "Price", "type": "CURR_USD", "value": 175.05 }, { "field": { "name": "market_cap" }, "name": "Market Cap", "type": "CURR_USD", "value": 3500000000000 }, { "field": { "name": "beta" }, "name": "Beta", "value": 1.2 }, { "field": { "lookback": "ONE_WEEK", "name": "change_pct" }, "name": "Change (1W)", "type": "PERCENT", "value": 2.35 }, { "field": { "name": "consensus_rating" }, "name": "Consensus Rating", "value": "STRONG_BUY" }, { "field": { "name": "earnings_per_share", "period": "QUARTER" }, "name": "EPS (Q)", "type": "CURR_USD", "value": 1.55 } ], [ { "field": { "name": "symbol" }, "name": "Symbol", "value": "F" }, { "field": { "name": "price" }, "name": "Price", "type": "CURR_USD", "value": 12.5 }, { "field": { "name": "market_cap" }, "name": "Market Cap", "type": "CURR_USD", "value": 45000000000 }, { "field": { "name": "beta" }, "name": "Beta", "value": 1.5 }, { "field": { "lookback": "ONE_WEEK", "name": "change_pct" }, "name": "Change (1W)", "type": "PERCENT", "value": -0.85 }, { "field": { "name": "consensus_rating" }, "name": "Consensus Rating", "value": "HOLD" }, { "field": { "name": "earnings_per_share", "period": "QUARTER" }, "name": "EPS (Q)", "type": "CURR_USD", "value": 0.23 } ] ], "metadata": { "next_page_token": "AAAAAAAAAAoAAAAAAAAAAg", "request_id": "abc-123" } } ``` ## Get Screeners `client.V1.Screener.GetScreeners(ctx) (*V1ScreenerGetScreenersResponse, error)` **get** `/v1/saved-screeners` List saved screener configurations. Returns all screener configurations for the authenticated user. ### Returns - `type V1ScreenerGetScreenersResponse struct{…}` - `Data ScreenerEntryList` - `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.GetScreeners(context.TODO()) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response) } ``` #### Response ```json { "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" } } ``` ## 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. ### Parameters - `screenerID string` ### Returns - `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 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.GetScreenerByID(context.TODO(), "550e8400-e29b-41d4-a716-446655440000") 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" } } ``` ## 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" } } ``` ## Replace Screener `client.V1.Screener.ReplaceScreener(ctx, screenerID, body) (*V1ScreenerReplaceScreenerResponse, error)` **put** `/v1/saved-screeners/{screener_id}` Update a saved screener configuration. Replaces the screener configuration for the authenticated user. If `name` is null, the existing name is preserved. ### Parameters - `screenerID string` - `body V1ScreenerReplaceScreenerParams` - `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 V1ScreenerReplaceScreenerResponse 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.ReplaceScreener( context.TODO(), "550e8400-e29b-41d4-a716-446655440000", clearstreet.V1ScreenerReplaceScreenerParams{ }, ) 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-04-23T13:37:04.041398Z", "filters": [ { "left": { "name": "market_cap" }, "op": { "name": "GREATER_OR_EQUAL" }, "right": [ { "value": 1000000000 } ] } ], "id": "69fcb40a-1812-4856-b2d3-97dec805efee", "name": "Tech Large Caps", "sorts": [ { "direction": "ASC", "field": { "name": "market_cap" } } ], "updated_at": "2026-04-23T13:37:21.860106Z" }, "metadata": { "request_id": "71ac58a8-9b12-49b9-8301-6239febe4e56" } } ``` ## Delete Screener `client.V1.Screener.DeleteScreener(ctx, screenerID) error` **delete** `/v1/saved-screeners/{screener_id}` Delete a saved screener configuration. Deletes the screener configuration for the authenticated user. ### Parameters - `screenerID string` ### Example ```go package main import ( "context" "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"), ) err := client.V1.Screener.DeleteScreener(context.TODO(), "550e8400-e29b-41d4-a716-446655440000") if err != nil { panic(err.Error()) } } ``` #### Response ```json { "error": { "code": 404, "message": "Some requested entity was not found" }, "metadata": { "request_id": "aafc54ec-939e-49a9-ab6e-bbabca005cb2" } } ``` ## Domain Types ### Field Lookback - `type FieldLookback string` Historical lookback window for price/change fields. - `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"` ### Field Period - `type FieldPeriod string` Reporting period for financial data fields. - `const FieldPeriodQuarter FieldPeriod = "QUARTER"` - `const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"` ### Field Ref - `type FieldRef struct{…}` A reference to a screener field. - `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"` ### Field Type - `type FieldType string` The data type of a screener field value. - `const FieldTypeDecimal FieldType = "DECIMAL"` - `const FieldTypeInteger FieldType = "INTEGER"` - `const FieldTypeString FieldType = "STRING"` - `const FieldTypeAnalystRating FieldType = "ANALYST_RATING"` - `const FieldTypeDate FieldType = "DATE"` ### Filter Op Spec - `type FilterOpSpec struct{…}` Operator specification with optional behavioral arguments. - `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"` ### Filter Operator - `type FilterOperator string` Filter operators supported by the screener. Abbreviated and lowercase forms are accepted as serde aliases for backward compatibility with earlier API revisions; the canonical wire form is the SCREAMING_SNAKE_CASE rendering. - `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"` ### Filter Value - `type FilterValue struct{…}` A filter value: either a literal or a variable reference. - `Value FilterValueValueUnion` - `float64` - `string` - `Variable Variable` A variable reference. - `Name string` The variable 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"` - `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. - `const FieldPeriodQuarter FieldPeriod = "QUARTER"` - `const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"` ### Modifier - `type Modifier struct{…}` Arithmetic modifier applied to a variable value. - `Args []ModifierArgUnion` - `float64` - `string` - `Name ModifierOp` The modifier operation. - `const ModifierOpAdd ModifierOp = "ADD"` - `const ModifierOpSubtract ModifierOp = "SUBTRACT"` ### Modifier Op - `type ModifierOp string` Modifier operation applied to a variable. - `const ModifierOpAdd ModifierOp = "ADD"` - `const ModifierOpSubtract ModifierOp = "SUBTRACT"` ### Operator Arg - `type OperatorArg string` Argument that modifies 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"` ### Screener Column - `type ScreenerColumn struct{…}` A single column in the screener search response. - `Field FieldRef` Field reference (same shape as filter/sort field references) - `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"` - `Name string` Human-readable display name for this field - `Value ScreenerColumnValueUnion` - `float64` - `string` - `Type string` Value format hint: "CURR_USD", "PERCENT", etc. Omitted when not applicable. When a null/undefined value is observed, it indicates it does not apply. ### Screener Entry - `type ScreenerEntry struct{…}` 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"` ### Screener Entry List - `type ScreenerEntryList []ScreenerEntry` - `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"` ### Screener Filter - `type ScreenerFilter struct{…}` A single filter criterion for the screener. - `Field string` Field to filter on (e.g., "market_cap", "sector", "price") - `Operator string` Comparison operator (e.g., "eq", "gte", "lte", "in") - `Value any` Filter value ### Screener Row - `type ScreenerRow []ScreenerColumn` A single row of screener columns for one instrument. - `Field FieldRef` Field reference (same shape as filter/sort field references) - `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"` - `Name string` Human-readable display name for this field - `Value ScreenerColumnValueUnion` - `float64` - `string` - `Type string` Value format hint: "CURR_USD", "PERCENT", etc. Omitted when not applicable. When a null/undefined value is observed, it indicates it does not apply. ### Screener Row List - `type ScreenerRowList []ScreenerRow` - `Field FieldRef` Field reference (same shape as filter/sort field references) - `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"` - `Name string` Human-readable display name for this field - `Value ScreenerColumnValueUnion` - `float64` - `string` - `Type string` Value format hint: "CURR_USD", "PERCENT", etc. Omitted when not applicable. When a null/undefined value is observed, it indicates it does not apply. ### Search Filter - `type SearchFilter struct{…}` A single filter condition. When `op` and `right` are both absent, the filter is "unenabled": it persists a `left` field reference without applying any predicate. Unenabled filters are skipped during search execution but still round-trip through save/load so callers can preserve draft state. - `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. ### Sort Spec - `type SortSpec struct{…}` A sort specification pairing a field with a direction. - `Field FieldRef` The field to sort by. - `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"` - `Direction SortDirection` Sort direction (defaults to DESC). - `const SortDirectionAsc SortDirection = "ASC"` - `const SortDirectionDesc SortDirection = "DESC"` ### Variable - `type Variable struct{…}` A variable reference (field or built-in like `today`). - `Name string` The variable 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"` - `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. - `const FieldPeriodQuarter FieldPeriod = "QUARTER"` - `const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"`