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

PUT/v1/saved-screeners/{screener_id}

Delete Screener

DELETE/v1/saved-screeners/{screener_id}

ModelsExpand Collapse

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"

Reporting period for financial data fields.

One of the following:

"QUARTER"

"TRAILING_TWELVE_MONTHS"

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"

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"

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"

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"

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"

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"

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"

name: string

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"

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"

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

Deprecated: use columns instead. Mirrors columns.

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"

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"

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"

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"

name: string

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"

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"

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

Deprecated: use columns instead. Mirrors columns.

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

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"

name: string

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"

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"

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

Deprecated: use columns instead. Mirrors columns.

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"

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"

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"

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"

name: string

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"

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"

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

Deprecated: use columns instead. Mirrors columns.

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"

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"

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"

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"

name: string

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"

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"

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

Deprecated: use columns instead. Mirrors columns.

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"

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"

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"

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"

name: string

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"

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"

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

Deprecated: use columns instead. Mirrors columns.

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"

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"

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"