API Reference

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Screener

Search instruments and manage saved screeners.

Search Screener

v1.screener.search_screener(ScreenerSearchScreenerParams**kwargs) -> ScreenerSearchScreenerResponse

POST/v1/screener

Get Screeners

v1.screener.get_screeners() -> ScreenerGetScreenersResponse

GET/v1/saved-screeners

Get Screener By ID

v1.screener.get_screener_by_id(strscreener_id) -> ScreenerGetScreenerByIDResponse

GET/v1/saved-screeners/{screener_id}

Create Screener

v1.screener.create_screener(ScreenerCreateScreenerParams**kwargs) -> ScreenerCreateScreenerResponse

POST/v1/saved-screeners

Replace Screener

Deprecated

v1.screener.replace_screener(strscreener_id, ScreenerReplaceScreenerParams**kwargs) -> ScreenerReplaceScreenerResponse

PUT/v1/saved-screeners/{screener_id}

Patch Screener

v1.screener.patch_screener(strscreener_id, ScreenerPatchScreenerParams**kwargs) -> ScreenerPatchScreenerResponse

PATCH/v1/saved-screeners/{screener_id}

Delete Screener

v1.screener.delete_screener(strscreener_id)

DELETE/v1/saved-screeners/{screener_id}

Get Screener Catalog

v1.screener.get_screener_catalog() -> ScreenerGetScreenerCatalogResponse

GET/v1/screener/catalog

ModelsExpand Collapse

class Catalog: …

The complete screener field catalog, serialized as the data payload of GET /screener/catalog.

default_response_fields: List[str]

The api_names 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.

formatint32

minimum0

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).

class Combination: …

A single combination, expressed with the API’s own parameter names.

At most one of period / lookback is set; a combination with neither selects the field’s 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.

class 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".

class FieldColumns: …

Struct-of-arrays: all four fields are the same length, index i is one field.

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.

class FieldKind: …

One deduplicated (category, format, value_type, combinations, default combination) tuple; fields.kind[i] indexes into Catalog::kinds.

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.

Literal["ONE_DAY", "ONE_WEEK", "ONE_MONTH", 4 more]

Historical lookback window for price/change fields.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

Literal["QUARTER", "TRAILING_TWELVE_MONTHS", "ANNUAL"]

Reporting period for financial data fields.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

class FieldRef: …

A reference to a screener field.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

Literal["DECIMAL", "INTEGER", "STRING", 2 more]

The data type of a screener field value.

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

class FilterOpSpec: …

Operator specification with optional behavioral arguments.

name: FilterOperator

The operator to apply.

One of the following:

"LESS_THAN"

"LESS_OR_EQUAL"

"GREATER_THAN"

"GREATER_OR_EQUAL"

"EQUAL"

"BETWEEN"

"NOT_BETWEEN"

"ONE_OF"

"REGEX"

"BEGINS_WITH"

"ENDS_WITH"

"CONTAINS"

"IS_NULL"

"IS_NOT_NULL"

args: Optional[List[OperatorArg]]

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

Literal["LESS_THAN", "LESS_OR_EQUAL", "GREATER_THAN", 11 more]

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.

One of the following:

"LESS_THAN"

"LESS_OR_EQUAL"

"GREATER_THAN"

"GREATER_OR_EQUAL"

"EQUAL"

"BETWEEN"

"NOT_BETWEEN"

"ONE_OF"

"REGEX"

"BEGINS_WITH"

"ENDS_WITH"

"CONTAINS"

"IS_NULL"

"IS_NOT_NULL"

class FilterValue: …

A filter value: either a literal or a variable reference.

value: Optional[Union[float, str, null]]

One of the following:

float

str

variable: Optional[Variable]

A variable reference.

name: str

The variable name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

modifier: Optional[Modifier]

Optional arithmetic modifier.

args: List[Union[float, str]]

One of the following:

float

str

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

period: Optional[FieldPeriod]

Optional reporting period.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

class Modifier: …

Arithmetic modifier applied to a variable value.

args: List[Union[float, str]]

One of the following:

float

str

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

class ModifierArg: …

One positional modifier.args slot.

kind: str

"NUMBER" or "ENUM".

note: str

The arg’s meaning and constraints.

position: int

Zero-based position in the args array.

formatint32

minimum0

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.

class ModifierDef: …

A modifier operation and the positional args each context accepts.

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.

formatint32

minimum0

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".

Literal["ADD", "SUBTRACT"]

Modifier operation applied to a variable.

One of the following:

"ADD"

"SUBTRACT"

Literal["LEFT_INCLUSIVE", "RIGHT_INCLUSIVE", "LEFT_EXCLUSIVE", 2 more]

Argument that modifies operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

class Rules: …

Request-side semantics: how to turn the catalog data into a valid POST /screener 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.

class ScreenerColumn: …

A single column in the screener search response.

field: FieldRef

Field reference (same shape as filter/sort field references)

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

name: str

Human-readable display name for this field

value: Union[float, str, null]

One of the following:

float

str

type: Optional[str]

Value format hint: “CURR_USD”, “PERCENT”, etc. Omitted when not applicable. When a null/undefined value is observed, it indicates it does not apply.

class ScreenerEntry: …

A saved screener configuration entry

id: str

created_at: datetime

filters: List[SearchFilter]

left: FieldRef

The field to filter on.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

op: Optional[FilterOpSpec]

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

name: FilterOperator

The operator to apply.

One of the following:

"LESS_THAN"

"LESS_OR_EQUAL"

"GREATER_THAN"

"GREATER_OR_EQUAL"

"EQUAL"

"BETWEEN"

"NOT_BETWEEN"

"ONE_OF"

"REGEX"

"BEGINS_WITH"

"ENDS_WITH"

"CONTAINS"

"IS_NULL"

"IS_NOT_NULL"

args: Optional[List[OperatorArg]]

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: Optional[List[FilterValue]]

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

value: Optional[Union[float, str, null]]

One of the following:

float

str

variable: Optional[Variable]

A variable reference.

name: str

The variable name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

modifier: Optional[Modifier]

Optional arithmetic modifier.

args: List[Union[float, str]]

One of the following:

float

str

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

period: Optional[FieldPeriod]

Optional reporting period.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

name: str

shared: bool

Whether any user may fetch this screener by id.

updated_at: datetime

columns: Optional[List[FieldRef]]

Field references included when running this screener.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

sorts: Optional[List[SortSpec]]

field: FieldRef

The field to sort by.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

direction: Optional[SortDirection]

Sort direction (defaults to DESC).

One of the following:

"ASC"

"DESC"

List[ScreenerEntry]

id: str

created_at: datetime

filters: List[SearchFilter]

left: FieldRef

The field to filter on.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

op: Optional[FilterOpSpec]

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

name: FilterOperator

The operator to apply.

One of the following:

"LESS_THAN"

"LESS_OR_EQUAL"

"GREATER_THAN"

"GREATER_OR_EQUAL"

"EQUAL"

"BETWEEN"

"NOT_BETWEEN"

"ONE_OF"

"REGEX"

"BEGINS_WITH"

"ENDS_WITH"

"CONTAINS"

"IS_NULL"

"IS_NOT_NULL"

args: Optional[List[OperatorArg]]

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: Optional[List[FilterValue]]

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

value: Optional[Union[float, str, null]]

One of the following:

float

str

variable: Optional[Variable]

A variable reference.

name: str

The variable name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

modifier: Optional[Modifier]

Optional arithmetic modifier.

args: List[Union[float, str]]

One of the following:

float

str

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

period: Optional[FieldPeriod]

Optional reporting period.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

name: str

shared: bool

Whether any user may fetch this screener by id.

updated_at: datetime

columns: Optional[List[FieldRef]]

Field references included when running this screener.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

sorts: Optional[List[SortSpec]]

field: FieldRef

The field to sort by.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

direction: Optional[SortDirection]

Sort direction (defaults to DESC).

One of the following:

"ASC"

"DESC"

class ScreenerFilter: …

A single filter criterion for the screener.

field: str

Field to filter on (e.g., “market_cap”, “sector”, “price”)

operator: str

Comparison operator (e.g., “eq”, “gte”, “lte”, “in”)

value: object

Filter value

List[ScreenerColumn]

A single row of screener columns for one instrument.

field: FieldRef

Field reference (same shape as filter/sort field references)

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

name: str

Human-readable display name for this field

value: Union[float, str, null]

One of the following:

float

str

type: Optional[str]

Value format hint: “CURR_USD”, “PERCENT”, etc. Omitted when not applicable. When a null/undefined value is observed, it indicates it does not apply.

List[ScreenerRow]

field: FieldRef

Field reference (same shape as filter/sort field references)

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

name: str

Human-readable display name for this field

value: Union[float, str, null]

One of the following:

float

str

type: Optional[str]

Value format hint: “CURR_USD”, “PERCENT”, etc. Omitted when not applicable. When a null/undefined value is observed, it indicates it does not apply.

class SearchFilter: …

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: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

op: Optional[FilterOpSpec]

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

name: FilterOperator

The operator to apply.

One of the following:

"LESS_THAN"

"LESS_OR_EQUAL"

"GREATER_THAN"

"GREATER_OR_EQUAL"

"EQUAL"

"BETWEEN"

"NOT_BETWEEN"

"ONE_OF"

"REGEX"

"BEGINS_WITH"

"ENDS_WITH"

"CONTAINS"

"IS_NULL"

"IS_NOT_NULL"

args: Optional[List[OperatorArg]]

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: Optional[List[FilterValue]]

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

value: Optional[Union[float, str, null]]

One of the following:

float

str

variable: Optional[Variable]

A variable reference.

name: str

The variable name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

modifier: Optional[Modifier]

Optional arithmetic modifier.

args: List[Union[float, str]]

One of the following:

float

str

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

period: Optional[FieldPeriod]

Optional reporting period.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

class SortSpec: …

A sort specification pairing a field with a direction.

field: FieldRef

The field to sort by.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

direction: Optional[SortDirection]

Sort direction (defaults to DESC).

One of the following:

"ASC"

"DESC"

class Variable: …

A variable reference (field or built-in like today).

name: str

The variable name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

modifier: Optional[Modifier]

Optional arithmetic modifier.

args: List[Union[float, str]]

One of the following:

float

str

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

period: Optional[FieldPeriod]

Optional reporting period.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

class VariableDef: …

A built-in variable, as 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).

class ScreenerSearchScreenerResponse: …

data: ScreenerRowList

field: FieldRef

Field reference (same shape as filter/sort field references)

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

name: str

Human-readable display name for this field

value: Union[float, str, null]

One of the following:

float

str

type: Optional[str]

Value format hint: “CURR_USD”, “PERCENT”, etc. Omitted when not applicable. When a null/undefined value is observed, it indicates it does not apply.

class ScreenerGetScreenersResponse: …

data: ScreenerEntryList

id: str

created_at: datetime

filters: List[SearchFilter]

left: FieldRef

The field to filter on.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

op: Optional[FilterOpSpec]

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

name: FilterOperator

The operator to apply.

One of the following:

"LESS_THAN"

"LESS_OR_EQUAL"

"GREATER_THAN"

"GREATER_OR_EQUAL"

"EQUAL"

"BETWEEN"

"NOT_BETWEEN"

"ONE_OF"

"REGEX"

"BEGINS_WITH"

"ENDS_WITH"

"CONTAINS"

"IS_NULL"

"IS_NOT_NULL"

args: Optional[List[OperatorArg]]

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: Optional[List[FilterValue]]

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

value: Optional[Union[float, str, null]]

One of the following:

float

str

variable: Optional[Variable]

A variable reference.

name: str

The variable name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

modifier: Optional[Modifier]

Optional arithmetic modifier.

args: List[Union[float, str]]

One of the following:

float

str

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

period: Optional[FieldPeriod]

Optional reporting period.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

name: str

shared: bool

Whether any user may fetch this screener by id.

updated_at: datetime

columns: Optional[List[FieldRef]]

Field references included when running this screener.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

sorts: Optional[List[SortSpec]]

field: FieldRef

The field to sort by.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

direction: Optional[SortDirection]

Sort direction (defaults to DESC).

One of the following:

"ASC"

"DESC"

class ScreenerGetScreenerByIDResponse: …

data: ScreenerEntry

A saved screener configuration entry

id: str

created_at: datetime

filters: List[SearchFilter]

left: FieldRef

The field to filter on.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

op: Optional[FilterOpSpec]

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

name: FilterOperator

The operator to apply.

One of the following:

"LESS_THAN"

"LESS_OR_EQUAL"

"GREATER_THAN"

"GREATER_OR_EQUAL"

"EQUAL"

"BETWEEN"

"NOT_BETWEEN"

"ONE_OF"

"REGEX"

"BEGINS_WITH"

"ENDS_WITH"

"CONTAINS"

"IS_NULL"

"IS_NOT_NULL"

args: Optional[List[OperatorArg]]

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: Optional[List[FilterValue]]

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

value: Optional[Union[float, str, null]]

One of the following:

float

str

variable: Optional[Variable]

A variable reference.

name: str

The variable name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

modifier: Optional[Modifier]

Optional arithmetic modifier.

args: List[Union[float, str]]

One of the following:

float

str

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

period: Optional[FieldPeriod]

Optional reporting period.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

name: str

shared: bool

Whether any user may fetch this screener by id.

updated_at: datetime

columns: Optional[List[FieldRef]]

Field references included when running this screener.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

sorts: Optional[List[SortSpec]]

field: FieldRef

The field to sort by.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

direction: Optional[SortDirection]

Sort direction (defaults to DESC).

One of the following:

"ASC"

"DESC"

class ScreenerCreateScreenerResponse: …

data: ScreenerEntry

A saved screener configuration entry

id: str

created_at: datetime

filters: List[SearchFilter]

left: FieldRef

The field to filter on.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

op: Optional[FilterOpSpec]

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

name: FilterOperator

The operator to apply.

One of the following:

"LESS_THAN"

"LESS_OR_EQUAL"

"GREATER_THAN"

"GREATER_OR_EQUAL"

"EQUAL"

"BETWEEN"

"NOT_BETWEEN"

"ONE_OF"

"REGEX"

"BEGINS_WITH"

"ENDS_WITH"

"CONTAINS"

"IS_NULL"

"IS_NOT_NULL"

args: Optional[List[OperatorArg]]

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: Optional[List[FilterValue]]

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

value: Optional[Union[float, str, null]]

One of the following:

float

str

variable: Optional[Variable]

A variable reference.

name: str

The variable name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

modifier: Optional[Modifier]

Optional arithmetic modifier.

args: List[Union[float, str]]

One of the following:

float

str

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

period: Optional[FieldPeriod]

Optional reporting period.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

name: str

shared: bool

Whether any user may fetch this screener by id.

updated_at: datetime

columns: Optional[List[FieldRef]]

Field references included when running this screener.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

sorts: Optional[List[SortSpec]]

field: FieldRef

The field to sort by.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

direction: Optional[SortDirection]

Sort direction (defaults to DESC).

One of the following:

"ASC"

"DESC"

class ScreenerReplaceScreenerResponse: …

data: ScreenerEntry

A saved screener configuration entry

id: str

created_at: datetime

filters: List[SearchFilter]

left: FieldRef

The field to filter on.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

op: Optional[FilterOpSpec]

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

name: FilterOperator

The operator to apply.

One of the following:

"LESS_THAN"

"LESS_OR_EQUAL"

"GREATER_THAN"

"GREATER_OR_EQUAL"

"EQUAL"

"BETWEEN"

"NOT_BETWEEN"

"ONE_OF"

"REGEX"

"BEGINS_WITH"

"ENDS_WITH"

"CONTAINS"

"IS_NULL"

"IS_NOT_NULL"

args: Optional[List[OperatorArg]]

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: Optional[List[FilterValue]]

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

value: Optional[Union[float, str, null]]

One of the following:

float

str

variable: Optional[Variable]

A variable reference.

name: str

The variable name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

modifier: Optional[Modifier]

Optional arithmetic modifier.

args: List[Union[float, str]]

One of the following:

float

str

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

period: Optional[FieldPeriod]

Optional reporting period.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

name: str

shared: bool

Whether any user may fetch this screener by id.

updated_at: datetime

columns: Optional[List[FieldRef]]

Field references included when running this screener.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

sorts: Optional[List[SortSpec]]

field: FieldRef

The field to sort by.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

direction: Optional[SortDirection]

Sort direction (defaults to DESC).

One of the following:

"ASC"

"DESC"

class ScreenerPatchScreenerResponse: …

data: ScreenerEntry

A saved screener configuration entry

id: str

created_at: datetime

filters: List[SearchFilter]

left: FieldRef

The field to filter on.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

op: Optional[FilterOpSpec]

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

name: FilterOperator

The operator to apply.

One of the following:

"LESS_THAN"

"LESS_OR_EQUAL"

"GREATER_THAN"

"GREATER_OR_EQUAL"

"EQUAL"

"BETWEEN"

"NOT_BETWEEN"

"ONE_OF"

"REGEX"

"BEGINS_WITH"

"ENDS_WITH"

"CONTAINS"

"IS_NULL"

"IS_NOT_NULL"

args: Optional[List[OperatorArg]]

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: Optional[List[FilterValue]]

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

value: Optional[Union[float, str, null]]

One of the following:

float

str

variable: Optional[Variable]

A variable reference.

name: str

The variable name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

modifier: Optional[Modifier]

Optional arithmetic modifier.

args: List[Union[float, str]]

One of the following:

float

str

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

period: Optional[FieldPeriod]

Optional reporting period.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

name: str

shared: bool

Whether any user may fetch this screener by id.

updated_at: datetime

columns: Optional[List[FieldRef]]

Field references included when running this screener.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

sorts: Optional[List[SortSpec]]

field: FieldRef

The field to sort by.

name: str

The field name.

lookback: Optional[FieldLookback]

Optional historical lookback window.

One of the following:

"ONE_DAY"

"ONE_WEEK"

"ONE_MONTH"

"THREE_MONTHS"

"SIX_MONTHS"

"YEAR_TO_DATE"

"ONE_YEAR"

period: Optional[FieldPeriod]

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

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

value_type: Optional[FieldType]

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

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

direction: Optional[SortDirection]

Sort direction (defaults to DESC).

One of the following:

"ASC"

"DESC"

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_names 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.

formatint32

minimum0

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).