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

POST/v1/screener

Get Screeners

GET/v1/saved-screeners

Get Screener By ID

GET/v1/saved-screeners/{screener_id}

Create Screener

POST/v1/saved-screeners

Replace Screener

Deprecated

PUT/v1/saved-screeners/{screener_id}

Patch Screener

PATCH/v1/saved-screeners/{screener_id}

Delete Screener

DELETE/v1/saved-screeners/{screener_id}

Get Screener Catalog

GET/v1/screener/catalog

ModelsExpand Collapse

Catalog object { default_response_fields, enums, fields, 6 more }

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

default_response_fields: array of string

The api_names that resolve to the POST default column set when columns is omitted.

enums: Enums { builtin_variable, category, date_unit, 7 more }

The enum universes every other section’s values are drawn from.

builtin_variable: array of string

The built-in variable names, e.g. "today", "start_of_year".

category: array of string

FieldCategory variants, e.g. "PROFILE", "VALUATION".

date_unit: array of string

The modifier date units, e.g. "DAY", "YEAR".

format: array of string

FieldFormat variants, e.g. "CURRENCY", "PERCENT".

lookback: array of string

FieldLookback variants, e.g. "ONE_WEEK", "YEAR_TO_DATE".

modifier_op: array of string

The modifier operation names, "ADD" and "SUBTRACT".

operator: array of string

FilterOperator variants, e.g. "BETWEEN", "ONE_OF".

operator_arg: array of string

The modifier arg forms, e.g. "LEFT_INCLUSIVE".

period: array of string

FieldPeriod variants, e.g. "QUARTER", "ANNUAL".

value_type: array of string

FieldValueType variants, e.g. "DECIMAL", "DATE".

fields: FieldColumns { description, display_name, kind, name }

Struct-of-arrays of the remaining per-field scalars.

description: array of string

A human-readable description of the field.

display_name: array of string

The display name of the column when no period / lookback is set.

kind: array of number

Index into Catalog::kinds.

name: array of string

The base field name, as accepted in a request’s left.name / right[].variable field reference.

kinds: array of FieldKind { category, combinations, default_combination, 2 more }

The deduplicated (category, format, value_type, combinations, default combination) tuples; fields.kind[i] indexes into this.

category: string

The field’s category, a member of enums.category.

combinations: array of Combination { lookback, period }

Ordered, in declaration order. The empty combination is the current or most recent value.

lookback: optional string

The lookback, a member of enums.lookback.

period: optional string

The period, a member of enums.period.

default_combination: Combination { lookback, period }

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 string

The lookback, a member of enums.lookback.

period: optional string

The period, a member of enums.period.

format: string

The field’s format, a member of enums.format.

value_type: string

The field’s value type, a member of enums.value_type.

modifiers: array of ModifierDef { args, name }

The modifier operations and their legal args forms.

args: array of ModifierArg { kind, note, position, 3 more }

The positional args slots, in order.

kind: string

"NUMBER" or "ENUM".

note: string

The arg’s meaning and constraints.

position: number

Zero-based position in the args array.

formatint32

minimum0

required: boolean

Whether the arg must be present in every modifier use.

default: optional string

For optional args: the value used when the arg is omitted.

ref: optional string

For "ENUM" args: the enums list the value must be a member of.

name: string

The modifier operation name: one of "ADD" or "SUBTRACT".

operators_by_value_type: map[array of string]

value_type -> canonically-ordered valid operators.

rules: Rules { api_name_composition, axes, defaults, 3 more }

Request-side semantics for turning the data into a valid call.

api_name_composition: string

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

At most one of period / lookback; the empty combination selects the field’s current or most recent value.

defaults: string

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

Where modifier is legal, its args forms, and unit semantics.

operators: string

Filter operator value counts for the right array.

variables: string

Built-in variables and field references in right[].variable.

suffixes: map[string]

Axis token -> abbreviation, for every token in use in kinds.

variables: array of VariableDef { description, name, resolves_to }

The built-in variables accepted in filters[].right[].variable.

description: string

A human-readable description of what the variable resolves to.

name: string

The variable name as accepted in filters[].right[].variable.

resolves_to: string

What the variable resolves to at call time (DATE for all built-ins).

Combination object { lookback, period }

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 string

The lookback, a member of enums.lookback.

period: optional string

The period, a member of enums.period.

Enums object { builtin_variable, category, date_unit, 7 more }

The enum universes every other section’s values are drawn from.

builtin_variable: array of string

The built-in variable names, e.g. "today", "start_of_year".

category: array of string

FieldCategory variants, e.g. "PROFILE", "VALUATION".

date_unit: array of string

The modifier date units, e.g. "DAY", "YEAR".

format: array of string

FieldFormat variants, e.g. "CURRENCY", "PERCENT".

lookback: array of string

FieldLookback variants, e.g. "ONE_WEEK", "YEAR_TO_DATE".

modifier_op: array of string

The modifier operation names, "ADD" and "SUBTRACT".

operator: array of string

FilterOperator variants, e.g. "BETWEEN", "ONE_OF".

operator_arg: array of string

The modifier arg forms, e.g. "LEFT_INCLUSIVE".

period: array of string

FieldPeriod variants, e.g. "QUARTER", "ANNUAL".

value_type: array of string

FieldValueType variants, e.g. "DECIMAL", "DATE".

FieldColumns object { description, display_name, kind, name }

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

description: array of string

A human-readable description of the field.

display_name: array of string

The display name of the column when no period / lookback is set.

kind: array of number

Index into Catalog::kinds.

name: array of string

The base field name, as accepted in a request’s left.name / right[].variable field reference.

FieldKind object { category, combinations, default_combination, 2 more }

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

category: string

The field’s category, a member of enums.category.

combinations: array of Combination { lookback, period }

Ordered, in declaration order. The empty combination is the current or most recent value.

lookback: optional string

The lookback, a member of enums.lookback.

period: optional string

The period, a member of enums.period.

default_combination: Combination { lookback, period }

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 string

The lookback, a member of enums.lookback.

period: optional string

The period, a member of enums.period.

format: string

The field’s format, a member of enums.format.

value_type: string

The field’s value type, a member of enums.value_type.

FieldLookback = "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 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"

FieldPeriod = "QUARTER" or "TRAILING_TWELVE_MONTHS" or "ANNUAL"

Reporting period for financial data fields.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

"ANNUAL"

FieldRef object { name, lookback, period, value_type }

A reference to a screener field.

name: string

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"

FieldType = "DECIMAL" or "INTEGER" or "STRING" or 2 more

The data type of a screener field value.

One of the following:

"DECIMAL"

"INTEGER"

"STRING"

"ANALYST_RATING"

"DATE"

FilterOpSpec object { name, args }

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 array of OperatorArg

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

FilterOperator = "LESS_THAN" or "LESS_OR_EQUAL" or "GREATER_THAN" or 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"

FilterValue object { value, variable }

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

value: optional number or string

One of the following:

number

string

variable: optional Variable { name, lookback, modifier, period }

A variable reference.

name: string

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 { args, name }

Optional arithmetic modifier.

args: array of number or string

One of the following:

number

string

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"

Modifier object { args, name }

Arithmetic modifier applied to a variable value.

args: array of number or string

One of the following:

number

string

name: ModifierOp

The modifier operation.

One of the following:

"ADD"

"SUBTRACT"

ModifierArg object { kind, note, position, 3 more }

One positional modifier.args slot.

kind: string

"NUMBER" or "ENUM".

note: string

The arg’s meaning and constraints.

position: number

Zero-based position in the args array.

formatint32

minimum0

required: boolean

Whether the arg must be present in every modifier use.

default: optional string

For optional args: the value used when the arg is omitted.

ref: optional string

For "ENUM" args: the enums list the value must be a member of.

ModifierDef object { args, name }

A modifier operation and the positional args each context accepts.

args: array of ModifierArg { kind, note, position, 3 more }

The positional args slots, in order.

kind: string

"NUMBER" or "ENUM".

note: string

The arg’s meaning and constraints.

position: number

Zero-based position in the args array.

formatint32

minimum0

required: boolean

Whether the arg must be present in every modifier use.

default: optional string

For optional args: the value used when the arg is omitted.

ref: optional string

For "ENUM" args: the enums list the value must be a member of.

name: string

The modifier operation name: one of "ADD" or "SUBTRACT".

ModifierOp = "ADD" or "SUBTRACT"

Modifier operation applied to a variable.

One of the following:

"ADD"

"SUBTRACT"

OperatorArg = "LEFT_INCLUSIVE" or "RIGHT_INCLUSIVE" or "LEFT_EXCLUSIVE" or 2 more

Argument that modifies operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

Rules object { api_name_composition, axes, defaults, 3 more }

Request-side semantics: how to turn the catalog data into a valid POST /screener call.

api_name_composition: string

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

At most one of period / lookback; the empty combination selects the field’s current or most recent value.

defaults: string

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

Where modifier is legal, its args forms, and unit semantics.

operators: string

Filter operator value counts for the right array.

variables: string

Built-in variables and field references in right[].variable.

ScreenerColumn object { field, name, value, type }

A single column in the screener search response.

field: FieldRef { name, lookback, period, value_type }

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

name: string

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

Human-readable display name for this field

value: number or string

One of the following:

number

string

type: optional 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.

ScreenerEntry object { id, created_at, filters, 5 more }

A saved screener configuration entry

id: string

created_at: string

filters: array of SearchFilter { left, op, right }

left: FieldRef { name, lookback, period, value_type }

The field to filter on.

name: string

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 { name, args }

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 array of OperatorArg

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: optional array of FilterValue { value, variable }

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

value: optional number or string

One of the following:

number

string

variable: optional Variable { name, lookback, modifier, period }

A variable reference.

name: string

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 { args, name }

Optional arithmetic modifier.

args: array of number or string

One of the following:

number

string

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

shared: boolean

Whether any user may fetch this screener by id.

updated_at: string

columns: optional array of FieldRef { name, lookback, period, value_type }

Field references included when running this screener.

name: string

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 array of SortSpec { field, direction }

field: FieldRef { name, lookback, period, value_type }

The field to sort by.

name: string

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"

ScreenerEntryList = array of ScreenerEntry { id, created_at, filters, 5 more }

id: string

created_at: string

filters: array of SearchFilter { left, op, right }

left: FieldRef { name, lookback, period, value_type }

The field to filter on.

name: string

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 { name, args }

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 array of OperatorArg

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: optional array of FilterValue { value, variable }

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

value: optional number or string

One of the following:

number

string

variable: optional Variable { name, lookback, modifier, period }

A variable reference.

name: string

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 { args, name }

Optional arithmetic modifier.

args: array of number or string

One of the following:

number

string

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

shared: boolean

Whether any user may fetch this screener by id.

updated_at: string

columns: optional array of FieldRef { name, lookback, period, value_type }

Field references included when running this screener.

name: string

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 array of SortSpec { field, direction }

field: FieldRef { name, lookback, period, value_type }

The field to sort by.

name: string

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"

ScreenerFilter object { field, operator, value }

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

Filter value

ScreenerRow = array of ScreenerColumn { field, name, value, type }

A single row of screener columns for one instrument.

field: FieldRef { name, lookback, period, value_type }

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

name: string

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

Human-readable display name for this field

value: number or string

One of the following:

number

string

type: optional 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.

ScreenerRowList = array of ScreenerRow { field, name, value, type }

field: FieldRef { name, lookback, period, value_type }

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

name: string

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

Human-readable display name for this field

value: number or string

One of the following:

number

string

type: optional 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.

SearchFilter object { left, op, right }

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 { name, lookback, period, value_type }

The field to filter on.

name: string

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 { name, args }

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 array of OperatorArg

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: optional array of FilterValue { value, variable }

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

value: optional number or string

One of the following:

number

string

variable: optional Variable { name, lookback, modifier, period }

A variable reference.

name: string

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 { args, name }

Optional arithmetic modifier.

args: array of number or string

One of the following:

number

string

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"

SortSpec object { field, direction }

A sort specification pairing a field with a direction.

field: FieldRef { name, lookback, period, value_type }

The field to sort by.

name: string

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"

Variable object { name, lookback, modifier, period }

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

name: string

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 { args, name }

Optional arithmetic modifier.

args: array of number or string

One of the following:

number

string

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"

VariableDef object { description, name, resolves_to }

A built-in variable, as accepted in filters[].right[].variable.

description: string

A human-readable description of what the variable resolves to.

name: string

The variable name as accepted in filters[].right[].variable.

resolves_to: string

What the variable resolves to at call time (DATE for all built-ins).

ScreenerSearchScreenerResponse = BaseResponse { metadata, error }

data: ScreenerRowList { field, name, value, type }

field: FieldRef { name, lookback, period, value_type }

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

name: string

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

Human-readable display name for this field

value: number or string

One of the following:

number

string

type: optional 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.

ScreenerGetScreenersResponse = BaseResponse { metadata, error }

data: ScreenerEntryList { id, created_at, filters, 5 more }

id: string

created_at: string

filters: array of SearchFilter { left, op, right }

left: FieldRef { name, lookback, period, value_type }

The field to filter on.

name: string

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 { name, args }

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 array of OperatorArg

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: optional array of FilterValue { value, variable }

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

value: optional number or string

One of the following:

number

string

variable: optional Variable { name, lookback, modifier, period }

A variable reference.

name: string

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 { args, name }

Optional arithmetic modifier.

args: array of number or string

One of the following:

number

string

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

shared: boolean

Whether any user may fetch this screener by id.

updated_at: string

columns: optional array of FieldRef { name, lookback, period, value_type }

Field references included when running this screener.

name: string

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 array of SortSpec { field, direction }

field: FieldRef { name, lookback, period, value_type }

The field to sort by.

name: string

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"

ScreenerGetScreenerByIDResponse = BaseResponse { metadata, error }

data: ScreenerEntry { id, created_at, filters, 5 more }

A saved screener configuration entry

id: string

created_at: string

filters: array of SearchFilter { left, op, right }

left: FieldRef { name, lookback, period, value_type }

The field to filter on.

name: string

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 { name, args }

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 array of OperatorArg

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: optional array of FilterValue { value, variable }

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

value: optional number or string

One of the following:

number

string

variable: optional Variable { name, lookback, modifier, period }

A variable reference.

name: string

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 { args, name }

Optional arithmetic modifier.

args: array of number or string

One of the following:

number

string

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

shared: boolean

Whether any user may fetch this screener by id.

updated_at: string

columns: optional array of FieldRef { name, lookback, period, value_type }

Field references included when running this screener.

name: string

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 array of SortSpec { field, direction }

field: FieldRef { name, lookback, period, value_type }

The field to sort by.

name: string

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"

ScreenerCreateScreenerResponse = BaseResponse { metadata, error }

data: ScreenerEntry { id, created_at, filters, 5 more }

A saved screener configuration entry

id: string

created_at: string

filters: array of SearchFilter { left, op, right }

left: FieldRef { name, lookback, period, value_type }

The field to filter on.

name: string

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 { name, args }

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 array of OperatorArg

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: optional array of FilterValue { value, variable }

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

value: optional number or string

One of the following:

number

string

variable: optional Variable { name, lookback, modifier, period }

A variable reference.

name: string

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 { args, name }

Optional arithmetic modifier.

args: array of number or string

One of the following:

number

string

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

shared: boolean

Whether any user may fetch this screener by id.

updated_at: string

columns: optional array of FieldRef { name, lookback, period, value_type }

Field references included when running this screener.

name: string

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 array of SortSpec { field, direction }

field: FieldRef { name, lookback, period, value_type }

The field to sort by.

name: string

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"

ScreenerReplaceScreenerResponse = BaseResponse { metadata, error }

data: ScreenerEntry { id, created_at, filters, 5 more }

A saved screener configuration entry

id: string

created_at: string

filters: array of SearchFilter { left, op, right }

left: FieldRef { name, lookback, period, value_type }

The field to filter on.

name: string

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 { name, args }

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 array of OperatorArg

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: optional array of FilterValue { value, variable }

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

value: optional number or string

One of the following:

number

string

variable: optional Variable { name, lookback, modifier, period }

A variable reference.

name: string

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 { args, name }

Optional arithmetic modifier.

args: array of number or string

One of the following:

number

string

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

shared: boolean

Whether any user may fetch this screener by id.

updated_at: string

columns: optional array of FieldRef { name, lookback, period, value_type }

Field references included when running this screener.

name: string

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 array of SortSpec { field, direction }

field: FieldRef { name, lookback, period, value_type }

The field to sort by.

name: string

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"

ScreenerPatchScreenerResponse = BaseResponse { metadata, error }

data: ScreenerEntry { id, created_at, filters, 5 more }

A saved screener configuration entry

id: string

created_at: string

filters: array of SearchFilter { left, op, right }

left: FieldRef { name, lookback, period, value_type }

The field to filter on.

name: string

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 { name, args }

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 array of OperatorArg

Optional arguments that modify operator behavior.

One of the following:

"LEFT_INCLUSIVE"

"RIGHT_INCLUSIVE"

"LEFT_EXCLUSIVE"

"RIGHT_EXCLUSIVE"

"CASE_INSENSITIVE"

right: optional array of FilterValue { value, variable }

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

value: optional number or string

One of the following:

number

string

variable: optional Variable { name, lookback, modifier, period }

A variable reference.

name: string

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 { args, name }

Optional arithmetic modifier.

args: array of number or string

One of the following:

number

string

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

shared: boolean

Whether any user may fetch this screener by id.

updated_at: string

columns: optional array of FieldRef { name, lookback, period, value_type }

Field references included when running this screener.

name: string

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 array of SortSpec { field, direction }

field: FieldRef { name, lookback, period, value_type }

The field to sort by.

name: string

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"

ScreenerGetScreenerCatalogResponse = BaseResponse { metadata, error }

data: Catalog { default_response_fields, enums, fields, 6 more }

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

default_response_fields: array of string

The api_names that resolve to the POST default column set when columns is omitted.

enums: Enums { builtin_variable, category, date_unit, 7 more }

The enum universes every other section’s values are drawn from.

builtin_variable: array of string

The built-in variable names, e.g. "today", "start_of_year".

category: array of string

FieldCategory variants, e.g. "PROFILE", "VALUATION".

date_unit: array of string

The modifier date units, e.g. "DAY", "YEAR".

format: array of string

FieldFormat variants, e.g. "CURRENCY", "PERCENT".

lookback: array of string

FieldLookback variants, e.g. "ONE_WEEK", "YEAR_TO_DATE".

modifier_op: array of string

The modifier operation names, "ADD" and "SUBTRACT".

operator: array of string

FilterOperator variants, e.g. "BETWEEN", "ONE_OF".

operator_arg: array of string

The modifier arg forms, e.g. "LEFT_INCLUSIVE".

period: array of string

FieldPeriod variants, e.g. "QUARTER", "ANNUAL".

value_type: array of string

FieldValueType variants, e.g. "DECIMAL", "DATE".

fields: FieldColumns { description, display_name, kind, name }

Struct-of-arrays of the remaining per-field scalars.

description: array of string

A human-readable description of the field.

display_name: array of string

The display name of the column when no period / lookback is set.

kind: array of number

Index into Catalog::kinds.

name: array of string

The base field name, as accepted in a request’s left.name / right[].variable field reference.

kinds: array of FieldKind { category, combinations, default_combination, 2 more }

The deduplicated (category, format, value_type, combinations, default combination) tuples; fields.kind[i] indexes into this.

category: string

The field’s category, a member of enums.category.

combinations: array of Combination { lookback, period }

Ordered, in declaration order. The empty combination is the current or most recent value.

lookback: optional string

The lookback, a member of enums.lookback.

period: optional string

The period, a member of enums.period.

default_combination: Combination { lookback, period }

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 string

The lookback, a member of enums.lookback.

period: optional string

The period, a member of enums.period.

format: string

The field’s format, a member of enums.format.

value_type: string

The field’s value type, a member of enums.value_type.

modifiers: array of ModifierDef { args, name }

The modifier operations and their legal args forms.

args: array of ModifierArg { kind, note, position, 3 more }

The positional args slots, in order.

kind: string

"NUMBER" or "ENUM".

note: string

The arg’s meaning and constraints.

position: number

Zero-based position in the args array.

formatint32

minimum0

required: boolean

Whether the arg must be present in every modifier use.

default: optional string

For optional args: the value used when the arg is omitted.

ref: optional string

For "ENUM" args: the enums list the value must be a member of.

name: string

The modifier operation name: one of "ADD" or "SUBTRACT".

operators_by_value_type: map[array of string]

value_type -> canonically-ordered valid operators.

rules: Rules { api_name_composition, axes, defaults, 3 more }

Request-side semantics for turning the data into a valid call.

api_name_composition: string

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

At most one of period / lookback; the empty combination selects the field’s current or most recent value.

defaults: string

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

Where modifier is legal, its args forms, and unit semantics.

operators: string

Filter operator value counts for the right array.

variables: string

Built-in variables and field references in right[].variable.

suffixes: map[string]

Axis token -> abbreviation, for every token in use in kinds.

variables: array of VariableDef { description, name, resolves_to }

The built-in variables accepted in filters[].right[].variable.

description: string

A human-readable description of what the variable resolves to.

name: string

The variable name as accepted in filters[].right[].variable.

resolves_to: string

What the variable resolves to at call time (DATE for all built-ins).