## Get Screener Catalog `v1.screener.get_screener_catalog() -> ScreenerGetScreenerCatalogResponse` **get** `/v1/screener/catalog` Returns the complete screener field catalog: the field `kinds`, the per-field data, the enum universes, the request-side `rules`, the built-in variables and modifiers, and the `POST /screener` default response fields. `POST /screener` field references are validated against this catalog; its `rules` object documents how to compose a valid request. ### Returns - `class ScreenerGetScreenerCatalogResponse: …` - `data: Catalog` The complete screener field catalog, serialized as the `data` payload of `GET /screener/catalog`. - `default_response_fields: List[str]` The `api_name`s that resolve to the POST default column set when `columns` is omitted. - `enums: Enums` The enum universes every other section's values are drawn from. - `builtin_variable: List[str]` The built-in variable names, e.g. `"today"`, `"start_of_year"`. - `category: List[str]` `FieldCategory` variants, e.g. `"PROFILE"`, `"VALUATION"`. - `date_unit: List[str]` The modifier date units, e.g. `"DAY"`, `"YEAR"`. - `format: List[str]` `FieldFormat` variants, e.g. `"CURRENCY"`, `"PERCENT"`. - `lookback: List[str]` `FieldLookback` variants, e.g. `"ONE_WEEK"`, `"YEAR_TO_DATE"`. - `modifier_op: List[str]` The modifier operation names, `"ADD"` and `"SUBTRACT"`. - `operator: List[str]` `FilterOperator` variants, e.g. `"BETWEEN"`, `"ONE_OF"`. - `operator_arg: List[str]` The modifier arg forms, e.g. `"LEFT_INCLUSIVE"`. - `period: List[str]` `FieldPeriod` variants, e.g. `"QUARTER"`, `"ANNUAL"`. - `value_type: List[str]` `FieldValueType` variants, e.g. `"DECIMAL"`, `"DATE"`. - `fields: FieldColumns` Struct-of-arrays of the remaining per-field scalars. - `description: List[str]` A human-readable description of the field. - `display_name: List[str]` The display name of the column when no `period` / `lookback` is set. - `kind: List[int]` Index into `Catalog::kinds`. - `name: List[str]` The base field name, as accepted in a request's `left.name` / `right[].variable` field reference. - `kinds: List[FieldKind]` The deduplicated `(category, format, value_type, combinations, default combination)` tuples; `fields.kind[i]` indexes into this. - `category: str` The field's category, a member of `enums.category`. - `combinations: List[Combination]` Ordered, in declaration order. The empty combination is the current or most recent value. - `lookback: Optional[str]` The lookback, a member of `enums.lookback`. - `period: Optional[str]` The period, a member of `enums.period`. - `default_combination: Combination` The combination a bare field reference resolves to: the field's current or most recent value when the kind offers it, otherwise the kind's default `period` / `lookback`. - `lookback: Optional[str]` The lookback, a member of `enums.lookback`. - `period: Optional[str]` The period, a member of `enums.period`. - `format: str` The field's format, a member of `enums.format`. - `value_type: str` The field's value type, a member of `enums.value_type`. - `modifiers: List[ModifierDef]` The modifier operations and their legal `args` forms. - `args: List[ModifierArg]` The positional `args` slots, in order. - `kind: str` `"NUMBER"` or `"ENUM"`. - `note: str` The arg's meaning and constraints. - `position: int` Zero-based position in the `args` array. - `required: bool` Whether the arg must be present in every modifier use. - `default: Optional[str]` For optional args: the value used when the arg is omitted. - `ref: Optional[str]` For `"ENUM"` args: the `enums` list the value must be a member of. - `name: str` The modifier operation name: one of `"ADD"` or `"SUBTRACT"`. - `operators_by_value_type: Dict[str, List[str]]` `value_type` -> canonically-ordered valid operators. - `rules: Rules` Request-side semantics for turning the data into a valid call. - `api_name_composition: str` Requests and response `field` objects use the same reference shape: base name plus at most one of `period` / `lookback`; `default_response_fields` (the POST default column set when `columns` is omitted) carries api_names, each decoding via `suffixes`. - `axes: str` At most one of `period` / `lookback`; the empty combination selects the field's current or most recent value. - `defaults: str` Omitting both is always valid; it resolves to the field's current or most recent value when the kind offers it, otherwise to `default_combination`. - `modifiers: str` Where `modifier` is legal, its `args` forms, and unit semantics. - `operators: str` Filter operator value counts for the `right` array. - `variables: str` Built-in variables and field references in `right[].variable`. - `suffixes: Dict[str, str]` Axis token -> abbreviation, for every token in use in `kinds`. - `variables: List[VariableDef]` The built-in variables accepted in `filters[].right[].variable`. - `description: str` A human-readable description of what the variable resolves to. - `name: str` The variable name as accepted in `filters[].right[].variable`. - `resolves_to: str` What the variable resolves to at call time (`DATE` for all built-ins). ### Example ```python from clearstreet import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.screener.get_screener_catalog() print(response) ``` #### Response ```json { "data": { "default_response_fields": [ "market_cap", "earnings_per_share_ttm" ], "enums": { "category": [ "PROFILE", "MARKET_DATA" ], "operator": [ "LESS_THAN", "LESS_OR_EQUAL", "GREATER_THAN", "GREATER_OR_EQUAL", "EQUAL", "BETWEEN" ], "period": [ "QUARTER", "TRAILING_TWELVE_MONTHS", "ANNUAL" ], "value_type": [ "DECIMAL", "INTEGER", "STRING", "ANALYST_RATING", "DATE" ] }, "fields": { "description": [ "Trading symbol", "Market Identifier Code (MIC) for primary exchange" ], "display_name": [ "Symbol", "Security Exchange" ], "kind": [ 0, 0 ], "name": [ "symbol", "security_exchange" ] }, "kinds": [ { "category": "PROFILE", "combinations": [ {} ], "default_combination": {}, "format": "NONE", "value_type": "STRING" }, { "category": "PROFILE", "combinations": [ {} ], "default_combination": {}, "format": "COUNT", "value_type": "INTEGER" } ], "modifiers": [ { "args": [ { "kind": "NUMBER", "note": "Positive integer for date built-ins; any number for numeric BETWEEN field-ref bounds.", "position": 0, "required": true }, { "default": "DAY", "kind": "ENUM", "note": "Date built-ins only; ignored on numeric BETWEEN bounds.", "position": 1, "ref": "date_unit", "required": false } ], "name": "ADD" } ], "operators_by_value_type": { "ANALYST_RATING": [ "EQUAL", "ONE_OF", "IS_NULL", "IS_NOT_NULL" ] }, "rules": { "axes": "A combination carries at most one of `period` / `lookback`; the API rejects both together. The empty combination selects the field's current or most recent value and is present only when the kind offers it.", "operators": "`BETWEEN` and `NOT_BETWEEN` take exactly two `right` values; `ONE_OF` takes one or more; all other operators take exactly one; `IS_NULL` and `IS_NOT_NULL` take none (omit `right`)." }, "suffixes": { "ANNUAL": "a", "QUARTER": "q", "TRAILING_TWELVE_MONTHS": "ttm" }, "variables": [ { "description": "The current date in the server's local timezone.", "name": "today", "resolves_to": "DATE" } ] }, "error": null, "metadata": { "request_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef" } } ```