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

client.V1.Screener.SearchScreener(ctx, body) (*V1ScreenerSearchScreenerResponse, error)

POST/v1/screener

Get Screeners

client.V1.Screener.GetScreeners(ctx) (*V1ScreenerGetScreenersResponse, error)

GET/v1/saved-screeners

Get Screener By ID

client.V1.Screener.GetScreenerByID(ctx, screenerID) (*V1ScreenerGetScreenerByIDResponse, error)

GET/v1/saved-screeners/{screener_id}

Create Screener

client.V1.Screener.NewScreener(ctx, body) (*V1ScreenerNewScreenerResponse, error)

POST/v1/saved-screeners

Replace Screener

Deprecated

client.V1.Screener.ReplaceScreener(ctx, screenerID, body) (*V1ScreenerReplaceScreenerResponse, error)

PUT/v1/saved-screeners/{screener_id}

Patch Screener

client.V1.Screener.PatchScreener(ctx, screenerID, body) (*V1ScreenerPatchScreenerResponse, error)

PATCH/v1/saved-screeners/{screener_id}

Delete Screener

client.V1.Screener.DeleteScreener(ctx, screenerID) error

DELETE/v1/saved-screeners/{screener_id}

Get Screener Catalog

client.V1.Screener.GetScreenerCatalog(ctx) (*V1ScreenerGetScreenerCatalogResponse, error)

GET/v1/screener/catalog

ModelsExpand Collapse

type Catalog struct{…}

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

DefaultResponseFields []string

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

Enums Enums

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

BuiltinVariable []string

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

Category []string

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

DateUnit []string

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

Format []string

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

Lookback []string

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

ModifierOp []string

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

Operator []string

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

OperatorArg []string

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

Period []string

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

ValueType []string

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

Fields FieldColumns

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

Description []string

A human-readable description of the field.

DisplayName []string

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

Kind []int64

Index into Catalog::kinds.

Name []string

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

Kinds []FieldKind

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 []Combination

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

Lookback stringOptional

The lookback, a member of enums.lookback.

Period stringOptional

The period, a member of enums.period.

DefaultCombination Combination

The combination a bare field reference resolves to: the field’s current or most recent value when the kind offers it, otherwise the kind’s default period / lookback.

Lookback stringOptional

The lookback, a member of enums.lookback.

Period stringOptional

The period, a member of enums.period.

Format string

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

ValueType string

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

Modifiers []ModifierDef

The modifier operations and their legal args forms.

Args []ModifierArg

The positional args slots, in order.

Kind string

"NUMBER" or "ENUM".

Note string

The arg’s meaning and constraints.

Position int64

Zero-based position in the args array.

formatint32

minimum0

Required bool

Whether the arg must be present in every modifier use.

Default stringOptional

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

Ref stringOptional

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

Name string

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

OperatorsByValueType map[string, []string]

value_type -> canonically-ordered valid operators.

Rules Rules

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

APINameComposition 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, string]

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

Variables []VariableDef

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.

ResolvesTo string

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

type Combination struct{…}

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 stringOptional

The lookback, a member of enums.lookback.

Period stringOptional

The period, a member of enums.period.

type Enums struct{…}

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

BuiltinVariable []string

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

Category []string

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

DateUnit []string

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

Format []string

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

Lookback []string

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

ModifierOp []string

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

Operator []string

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

OperatorArg []string

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

Period []string

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

ValueType []string

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

type FieldColumns struct{…}

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

Description []string

A human-readable description of the field.

DisplayName []string

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

Kind []int64

Index into Catalog::kinds.

Name []string

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

type FieldKind struct{…}

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 []Combination

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

Lookback stringOptional

The lookback, a member of enums.lookback.

Period stringOptional

The period, a member of enums.period.

DefaultCombination Combination

The combination a bare field reference resolves to: the field’s current or most recent value when the kind offers it, otherwise the kind’s default period / lookback.

Lookback stringOptional

The lookback, a member of enums.lookback.

Period stringOptional

The period, a member of enums.period.

Format string

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

ValueType string

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

type FieldLookback string

Historical lookback window for price/change fields.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

type FieldPeriod string

Reporting period for financial data fields.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

type FieldRef struct{…}

A reference to a screener field.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

type FieldType string

The data type of a screener field value.

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

type FilterOpSpec struct{…}

Operator specification with optional behavioral arguments.

Name FilterOperator

The operator to apply.

One of the following:

const FilterOperatorLessThan FilterOperator = "LESS_THAN"

const FilterOperatorLessOrEqual FilterOperator = "LESS_OR_EQUAL"

const FilterOperatorGreaterThan FilterOperator = "GREATER_THAN"

const FilterOperatorGreaterOrEqual FilterOperator = "GREATER_OR_EQUAL"

const FilterOperatorEqual FilterOperator = "EQUAL"

const FilterOperatorBetween FilterOperator = "BETWEEN"

const FilterOperatorNotBetween FilterOperator = "NOT_BETWEEN"

const FilterOperatorOneOf FilterOperator = "ONE_OF"

const FilterOperatorRegex FilterOperator = "REGEX"

const FilterOperatorBeginsWith FilterOperator = "BEGINS_WITH"

const FilterOperatorEndsWith FilterOperator = "ENDS_WITH"

const FilterOperatorContains FilterOperator = "CONTAINS"

const FilterOperatorIsNull FilterOperator = "IS_NULL"

const FilterOperatorIsNotNull FilterOperator = "IS_NOT_NULL"

Args []OperatorArgOptional

Optional arguments that modify operator behavior.

One of the following:

const OperatorArgLeftInclusive OperatorArg = "LEFT_INCLUSIVE"

const OperatorArgRightInclusive OperatorArg = "RIGHT_INCLUSIVE"

const OperatorArgLeftExclusive OperatorArg = "LEFT_EXCLUSIVE"

const OperatorArgRightExclusive OperatorArg = "RIGHT_EXCLUSIVE"

const OperatorArgCaseInsensitive OperatorArg = "CASE_INSENSITIVE"

type FilterOperator string

Filter operators supported by the screener.

Abbreviated and lowercase forms are accepted as serde aliases for backward compatibility with earlier API revisions; the canonical wire form is the SCREAMING_SNAKE_CASE rendering.

One of the following:

const FilterOperatorLessThan FilterOperator = "LESS_THAN"

const FilterOperatorLessOrEqual FilterOperator = "LESS_OR_EQUAL"

const FilterOperatorGreaterThan FilterOperator = "GREATER_THAN"

const FilterOperatorGreaterOrEqual FilterOperator = "GREATER_OR_EQUAL"

const FilterOperatorEqual FilterOperator = "EQUAL"

const FilterOperatorBetween FilterOperator = "BETWEEN"

const FilterOperatorNotBetween FilterOperator = "NOT_BETWEEN"

const FilterOperatorOneOf FilterOperator = "ONE_OF"

const FilterOperatorRegex FilterOperator = "REGEX"

const FilterOperatorBeginsWith FilterOperator = "BEGINS_WITH"

const FilterOperatorEndsWith FilterOperator = "ENDS_WITH"

const FilterOperatorContains FilterOperator = "CONTAINS"

const FilterOperatorIsNull FilterOperator = "IS_NULL"

const FilterOperatorIsNotNull FilterOperator = "IS_NOT_NULL"

type FilterValue struct{…}

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

Value FilterValueValueUnionOptional

One of the following:

float64

string

Variable VariableOptional

A variable reference.

Name string

The variable name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Modifier ModifierOptional

Optional arithmetic modifier.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

Period FieldPeriodOptional

Optional reporting period.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

type Modifier struct{…}

Arithmetic modifier applied to a variable value.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

type ModifierArg struct{…}

One positional modifier.args slot.

Kind string

"NUMBER" or "ENUM".

Note string

The arg’s meaning and constraints.

Position int64

Zero-based position in the args array.

formatint32

minimum0

Required bool

Whether the arg must be present in every modifier use.

Default stringOptional

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

Ref stringOptional

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

type ModifierDef struct{…}

A modifier operation and the positional args each context accepts.

Args []ModifierArg

The positional args slots, in order.

Kind string

"NUMBER" or "ENUM".

Note string

The arg’s meaning and constraints.

Position int64

Zero-based position in the args array.

formatint32

minimum0

Required bool

Whether the arg must be present in every modifier use.

Default stringOptional

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

Ref stringOptional

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

Name string

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

type ModifierOp string

Modifier operation applied to a variable.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

type OperatorArg string

Argument that modifies operator behavior.

One of the following:

const OperatorArgLeftInclusive OperatorArg = "LEFT_INCLUSIVE"

const OperatorArgRightInclusive OperatorArg = "RIGHT_INCLUSIVE"

const OperatorArgLeftExclusive OperatorArg = "LEFT_EXCLUSIVE"

const OperatorArgRightExclusive OperatorArg = "RIGHT_EXCLUSIVE"

const OperatorArgCaseInsensitive OperatorArg = "CASE_INSENSITIVE"

type Rules struct{…}

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

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

type ScreenerColumn struct{…}

A single column in the screener search response.

Field FieldRef

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

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Name string

Human-readable display name for this field

Value ScreenerColumnValueUnion

One of the following:

float64

string

Type stringOptional

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

type ScreenerEntry struct{…}

A saved screener configuration entry

ID string

CreatedAt Time

Filters []SearchFilter

Left FieldRef

The field to filter on.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Op FilterOpSpecOptional

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

Name FilterOperator

The operator to apply.

One of the following:

const FilterOperatorLessThan FilterOperator = "LESS_THAN"

const FilterOperatorLessOrEqual FilterOperator = "LESS_OR_EQUAL"

const FilterOperatorGreaterThan FilterOperator = "GREATER_THAN"

const FilterOperatorGreaterOrEqual FilterOperator = "GREATER_OR_EQUAL"

const FilterOperatorEqual FilterOperator = "EQUAL"

const FilterOperatorBetween FilterOperator = "BETWEEN"

const FilterOperatorNotBetween FilterOperator = "NOT_BETWEEN"

const FilterOperatorOneOf FilterOperator = "ONE_OF"

const FilterOperatorRegex FilterOperator = "REGEX"

const FilterOperatorBeginsWith FilterOperator = "BEGINS_WITH"

const FilterOperatorEndsWith FilterOperator = "ENDS_WITH"

const FilterOperatorContains FilterOperator = "CONTAINS"

const FilterOperatorIsNull FilterOperator = "IS_NULL"

const FilterOperatorIsNotNull FilterOperator = "IS_NOT_NULL"

Args []OperatorArgOptional

Optional arguments that modify operator behavior.

One of the following:

const OperatorArgLeftInclusive OperatorArg = "LEFT_INCLUSIVE"

const OperatorArgRightInclusive OperatorArg = "RIGHT_INCLUSIVE"

const OperatorArgLeftExclusive OperatorArg = "LEFT_EXCLUSIVE"

const OperatorArgRightExclusive OperatorArg = "RIGHT_EXCLUSIVE"

const OperatorArgCaseInsensitive OperatorArg = "CASE_INSENSITIVE"

Right []FilterValueOptional

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

Value FilterValueValueUnionOptional

One of the following:

float64

string

Variable VariableOptional

A variable reference.

Name string

The variable name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Modifier ModifierOptional

Optional arithmetic modifier.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

Period FieldPeriodOptional

Optional reporting period.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

Name string

Shared bool

Whether any user may fetch this screener by id.

UpdatedAt Time

Columns []FieldRefOptional

Field references included when running this screener.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Sorts []SortSpecOptional

Field FieldRef

The field to sort by.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Direction SortDirectionOptional

Sort direction (defaults to DESC).

One of the following:

const SortDirectionAsc SortDirection = "ASC"

const SortDirectionDesc SortDirection = "DESC"

type ScreenerEntryList []ScreenerEntry

ID string

CreatedAt Time

Filters []SearchFilter

Left FieldRef

The field to filter on.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Op FilterOpSpecOptional

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

Name FilterOperator

The operator to apply.

One of the following:

const FilterOperatorLessThan FilterOperator = "LESS_THAN"

const FilterOperatorLessOrEqual FilterOperator = "LESS_OR_EQUAL"

const FilterOperatorGreaterThan FilterOperator = "GREATER_THAN"

const FilterOperatorGreaterOrEqual FilterOperator = "GREATER_OR_EQUAL"

const FilterOperatorEqual FilterOperator = "EQUAL"

const FilterOperatorBetween FilterOperator = "BETWEEN"

const FilterOperatorNotBetween FilterOperator = "NOT_BETWEEN"

const FilterOperatorOneOf FilterOperator = "ONE_OF"

const FilterOperatorRegex FilterOperator = "REGEX"

const FilterOperatorBeginsWith FilterOperator = "BEGINS_WITH"

const FilterOperatorEndsWith FilterOperator = "ENDS_WITH"

const FilterOperatorContains FilterOperator = "CONTAINS"

const FilterOperatorIsNull FilterOperator = "IS_NULL"

const FilterOperatorIsNotNull FilterOperator = "IS_NOT_NULL"

Args []OperatorArgOptional

Optional arguments that modify operator behavior.

One of the following:

const OperatorArgLeftInclusive OperatorArg = "LEFT_INCLUSIVE"

const OperatorArgRightInclusive OperatorArg = "RIGHT_INCLUSIVE"

const OperatorArgLeftExclusive OperatorArg = "LEFT_EXCLUSIVE"

const OperatorArgRightExclusive OperatorArg = "RIGHT_EXCLUSIVE"

const OperatorArgCaseInsensitive OperatorArg = "CASE_INSENSITIVE"

Right []FilterValueOptional

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

Value FilterValueValueUnionOptional

One of the following:

float64

string

Variable VariableOptional

A variable reference.

Name string

The variable name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Modifier ModifierOptional

Optional arithmetic modifier.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

Period FieldPeriodOptional

Optional reporting period.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

Name string

Shared bool

Whether any user may fetch this screener by id.

UpdatedAt Time

Columns []FieldRefOptional

Field references included when running this screener.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Sorts []SortSpecOptional

Field FieldRef

The field to sort by.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Direction SortDirectionOptional

Sort direction (defaults to DESC).

One of the following:

const SortDirectionAsc SortDirection = "ASC"

const SortDirectionDesc SortDirection = "DESC"

type ScreenerFilter struct{…}

A single filter criterion for the screener.

Field string

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

Operator string

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

Value any

Filter value

type ScreenerRow []ScreenerColumn

A single row of screener columns for one instrument.

Field FieldRef

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

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Name string

Human-readable display name for this field

Value ScreenerColumnValueUnion

One of the following:

float64

string

Type stringOptional

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

type ScreenerRowList []ScreenerRow

Field FieldRef

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

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Name string

Human-readable display name for this field

Value ScreenerColumnValueUnion

One of the following:

float64

string

Type stringOptional

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

type SearchFilter struct{…}

A single filter condition.

When op and right are both absent, the filter is “unenabled”: it persists a left field reference without applying any predicate. Unenabled filters are skipped during search execution but still round-trip through save/load so callers can preserve draft state.

Left FieldRef

The field to filter on.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Op FilterOpSpecOptional

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

Name FilterOperator

The operator to apply.

One of the following:

const FilterOperatorLessThan FilterOperator = "LESS_THAN"

const FilterOperatorLessOrEqual FilterOperator = "LESS_OR_EQUAL"

const FilterOperatorGreaterThan FilterOperator = "GREATER_THAN"

const FilterOperatorGreaterOrEqual FilterOperator = "GREATER_OR_EQUAL"

const FilterOperatorEqual FilterOperator = "EQUAL"

const FilterOperatorBetween FilterOperator = "BETWEEN"

const FilterOperatorNotBetween FilterOperator = "NOT_BETWEEN"

const FilterOperatorOneOf FilterOperator = "ONE_OF"

const FilterOperatorRegex FilterOperator = "REGEX"

const FilterOperatorBeginsWith FilterOperator = "BEGINS_WITH"

const FilterOperatorEndsWith FilterOperator = "ENDS_WITH"

const FilterOperatorContains FilterOperator = "CONTAINS"

const FilterOperatorIsNull FilterOperator = "IS_NULL"

const FilterOperatorIsNotNull FilterOperator = "IS_NOT_NULL"

Args []OperatorArgOptional

Optional arguments that modify operator behavior.

One of the following:

const OperatorArgLeftInclusive OperatorArg = "LEFT_INCLUSIVE"

const OperatorArgRightInclusive OperatorArg = "RIGHT_INCLUSIVE"

const OperatorArgLeftExclusive OperatorArg = "LEFT_EXCLUSIVE"

const OperatorArgRightExclusive OperatorArg = "RIGHT_EXCLUSIVE"

const OperatorArgCaseInsensitive OperatorArg = "CASE_INSENSITIVE"

Right []FilterValueOptional

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

Value FilterValueValueUnionOptional

One of the following:

float64

string

Variable VariableOptional

A variable reference.

Name string

The variable name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Modifier ModifierOptional

Optional arithmetic modifier.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

Period FieldPeriodOptional

Optional reporting period.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

type SortSpec struct{…}

A sort specification pairing a field with a direction.

Field FieldRef

The field to sort by.

Name string

The field name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Period FieldPeriodOptional

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

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

ValueType FieldTypeOptional

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

One of the following:

const FieldTypeDecimal FieldType = "DECIMAL"

const FieldTypeInteger FieldType = "INTEGER"

const FieldTypeString FieldType = "STRING"

const FieldTypeAnalystRating FieldType = "ANALYST_RATING"

const FieldTypeDate FieldType = "DATE"

Direction SortDirectionOptional

Sort direction (defaults to DESC).

One of the following:

const SortDirectionAsc SortDirection = "ASC"

const SortDirectionDesc SortDirection = "DESC"

type Variable struct{…}

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

Name string

The variable name.

Lookback FieldLookbackOptional

Optional historical lookback window.

One of the following:

const FieldLookbackOneDay FieldLookback = "ONE_DAY"

const FieldLookbackOneWeek FieldLookback = "ONE_WEEK"

const FieldLookbackOneMonth FieldLookback = "ONE_MONTH"

const FieldLookbackThreeMonths FieldLookback = "THREE_MONTHS"

const FieldLookbackSixMonths FieldLookback = "SIX_MONTHS"

const FieldLookbackYearToDate FieldLookback = "YEAR_TO_DATE"

const FieldLookbackOneYear FieldLookback = "ONE_YEAR"

Modifier ModifierOptional

Optional arithmetic modifier.

Args []ModifierArgUnion

One of the following:

float64

string

Name ModifierOp

The modifier operation.

One of the following:

const ModifierOpAdd ModifierOp = "ADD"

const ModifierOpSubtract ModifierOp = "SUBTRACT"

Period FieldPeriodOptional

Optional reporting period.

One of the following:

const FieldPeriodQuarter FieldPeriod = "QUARTER"

const FieldPeriodTrailingTwelveMonths FieldPeriod = "TRAILING_TWELVE_MONTHS"

const FieldPeriodAnnual FieldPeriod = "ANNUAL"

type VariableDef struct{…}

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.

ResolvesTo string

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