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

ScreenerSearchScreenerResponse v1().screener().searchScreener(ScreenerSearchScreenerParamsparams = ScreenerSearchScreenerParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/screener

Get Screeners

ScreenerGetScreenersResponse v1().screener().getScreeners(ScreenerGetScreenersParamsparams = ScreenerGetScreenersParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/saved-screeners

Get Screener By ID

ScreenerGetScreenerByIdResponse v1().screener().getScreenerById(ScreenerGetScreenerByIdParamsparams = ScreenerGetScreenerByIdParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/saved-screeners/{screener_id}

Create Screener

ScreenerCreateScreenerResponse v1().screener().createScreener(ScreenerCreateScreenerParamsparams = ScreenerCreateScreenerParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

POST/v1/saved-screeners

Replace Screener

Deprecated

ScreenerReplaceScreenerResponse v1().screener().replaceScreener(ScreenerReplaceScreenerParamsparams = ScreenerReplaceScreenerParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

PUT/v1/saved-screeners/{screener_id}

Patch Screener

ScreenerPatchScreenerResponse v1().screener().patchScreener(ScreenerPatchScreenerParamsparams = ScreenerPatchScreenerParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

PATCH/v1/saved-screeners/{screener_id}

Delete Screener

v1().screener().deleteScreener(ScreenerDeleteScreenerParamsparams = ScreenerDeleteScreenerParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/v1/saved-screeners/{screener_id}

Get Screener Catalog

ScreenerGetScreenerCatalogResponse v1().screener().getScreenerCatalog(ScreenerGetScreenerCatalogParamsparams = ScreenerGetScreenerCatalogParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/v1/screener/catalog

ModelsExpand Collapse

class Catalog:

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

List<String> defaultResponseFields

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.

List<String> builtinVariable

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

List<String> category

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

List<String> dateUnit

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

List<String> format

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

List<String> lookback

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

List<String> modifierOp

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

List<String> operator

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

List<String> operatorArg

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

List<String> period

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

List<String> valueType

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

FieldColumns fields

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

List<String> description

A human-readable description of the field.

List<String> displayName

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

List<long> kind

Index into Catalog::kinds.

List<String> name

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

List<FieldKind> kinds

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

String category

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

List<Combination> combinations

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

Optional<String> lookback

The lookback, a member of enums.lookback.

Optional<String> period

The period, a member of enums.period.

Combination defaultCombination

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.

Optional<String> lookback

The lookback, a member of enums.lookback.

Optional<String> period

The period, a member of enums.period.

String format

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

String valueType

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

List<ModifierDef> modifiers

The modifier operations and their legal args forms.

List<ModifierArg> args

The positional args slots, in order.

String kind

"NUMBER" or "ENUM".

String note

The arg’s meaning and constraints.

long position

Zero-based position in the args array.

formatint32

minimum0

boolean required

Whether the arg must be present in every modifier use.

Optional<String> default_

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

Optional<String> ref

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

String name

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

OperatorsByValueType operatorsByValueType

value_type -> canonically-ordered valid operators.

Rules rules

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

String apiNameComposition

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.

String axes

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

String defaults

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.

String modifiers

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

String operators

Filter operator value counts for the right array.

String variables

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

Suffixes suffixes

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

List<VariableDef> variables

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

String description

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

String name

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

String resolvesTo

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

class Combination:

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

At most one of period / lookback is set; a combination with neither selects the field’s current or most recent value.

Optional<String> lookback

The lookback, a member of enums.lookback.

Optional<String> period

The period, a member of enums.period.

class Enums:

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

List<String> builtinVariable

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

List<String> category

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

List<String> dateUnit

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

List<String> format

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

List<String> lookback

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

List<String> modifierOp

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

List<String> operator

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

List<String> operatorArg

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

List<String> period

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

List<String> valueType

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

class FieldColumns:

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

List<String> description

A human-readable description of the field.

List<String> displayName

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

List<long> kind

Index into Catalog::kinds.

List<String> name

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

class FieldKind:

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

String category

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

List<Combination> combinations

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

Optional<String> lookback

The lookback, a member of enums.lookback.

Optional<String> period

The period, a member of enums.period.

Combination defaultCombination

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.

Optional<String> lookback

The lookback, a member of enums.lookback.

Optional<String> period

The period, a member of enums.period.

String format

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

String valueType

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

enum FieldLookback:

Historical lookback window for price/change fields.

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

enum FieldPeriod:

Reporting period for financial data fields.

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

ANNUAL("ANNUAL")

class FieldRef:

A reference to a screener field.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

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

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

ANNUAL("ANNUAL")

Optional<FieldType> valueType

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

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

enum FieldType:

The data type of a screener field value.

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

class FilterOpSpec:

Operator specification with optional behavioral arguments.

FilterOperator name

The operator to apply.

One of the following:

LESS_THAN("LESS_THAN")

LESS_OR_EQUAL("LESS_OR_EQUAL")

GREATER_THAN("GREATER_THAN")

GREATER_OR_EQUAL("GREATER_OR_EQUAL")

EQUAL("EQUAL")

BETWEEN("BETWEEN")

NOT_BETWEEN("NOT_BETWEEN")

ONE_OF("ONE_OF")

REGEX("REGEX")

BEGINS_WITH("BEGINS_WITH")

ENDS_WITH("ENDS_WITH")

CONTAINS("CONTAINS")

IS_NULL("IS_NULL")

IS_NOT_NULL("IS_NOT_NULL")

Optional<List<OperatorArg>> args

Optional arguments that modify operator behavior.

One of the following:

LEFT_INCLUSIVE("LEFT_INCLUSIVE")

RIGHT_INCLUSIVE("RIGHT_INCLUSIVE")

LEFT_EXCLUSIVE("LEFT_EXCLUSIVE")

RIGHT_EXCLUSIVE("RIGHT_EXCLUSIVE")

CASE_INSENSITIVE("CASE_INSENSITIVE")

enum FilterOperator:

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.

LESS_THAN("LESS_THAN")

LESS_OR_EQUAL("LESS_OR_EQUAL")

GREATER_THAN("GREATER_THAN")

GREATER_OR_EQUAL("GREATER_OR_EQUAL")

EQUAL("EQUAL")

BETWEEN("BETWEEN")

NOT_BETWEEN("NOT_BETWEEN")

ONE_OF("ONE_OF")

REGEX("REGEX")

BEGINS_WITH("BEGINS_WITH")

ENDS_WITH("ENDS_WITH")

CONTAINS("CONTAINS")

IS_NULL("IS_NULL")

IS_NOT_NULL("IS_NOT_NULL")

class FilterValue:

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

Optional<Value> value

One of the following:

double

String

Optional<Variable> variable

A variable reference.

String name

The variable name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<Modifier> modifier

Optional arithmetic modifier.

List<Arg> args

One of the following:

double

String

ModifierOp name

The modifier operation.

One of the following:

ADD("ADD")

SUBTRACT("SUBTRACT")

Optional<FieldPeriod> period

Optional reporting period.

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

ANNUAL("ANNUAL")

class Modifier:

Arithmetic modifier applied to a variable value.

List<Arg> args

One of the following:

double

String

ModifierOp name

The modifier operation.

One of the following:

ADD("ADD")

SUBTRACT("SUBTRACT")

class ModifierArg:

One positional modifier.args slot.

String kind

"NUMBER" or "ENUM".

String note

The arg’s meaning and constraints.

long position

Zero-based position in the args array.

formatint32

minimum0

boolean required

Whether the arg must be present in every modifier use.

Optional<String> default_

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

Optional<String> ref

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

class ModifierDef:

A modifier operation and the positional args each context accepts.

List<ModifierArg> args

The positional args slots, in order.

String kind

"NUMBER" or "ENUM".

String note

The arg’s meaning and constraints.

long position

Zero-based position in the args array.

formatint32

minimum0

boolean required

Whether the arg must be present in every modifier use.

Optional<String> default_

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

Optional<String> ref

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

String name

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

enum ModifierOp:

Modifier operation applied to a variable.

ADD("ADD")

SUBTRACT("SUBTRACT")

enum OperatorArg:

Argument that modifies operator behavior.

LEFT_INCLUSIVE("LEFT_INCLUSIVE")

RIGHT_INCLUSIVE("RIGHT_INCLUSIVE")

LEFT_EXCLUSIVE("LEFT_EXCLUSIVE")

RIGHT_EXCLUSIVE("RIGHT_EXCLUSIVE")

CASE_INSENSITIVE("CASE_INSENSITIVE")

class Rules:

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

String apiNameComposition

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.

String axes

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

String defaults

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.

String modifiers

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

String operators

Filter operator value counts for the right array.

String variables

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

class ScreenerColumn:

A single column in the screener search response.

FieldRef field

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

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

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

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

ANNUAL("ANNUAL")

Optional<FieldType> valueType

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

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

String name

Human-readable display name for this field

Optional<Value> value

One of the following:

double

String

Optional<String> type

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

class ScreenerEntry:

A saved screener configuration entry

String id

LocalDateTime createdAt

List<SearchFilter> filters

FieldRef left

The field to filter on.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

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

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

ANNUAL("ANNUAL")

Optional<FieldType> valueType

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

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

Optional<FilterOpSpec> op

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

FilterOperator name

The operator to apply.

One of the following:

LESS_THAN("LESS_THAN")

LESS_OR_EQUAL("LESS_OR_EQUAL")

GREATER_THAN("GREATER_THAN")

GREATER_OR_EQUAL("GREATER_OR_EQUAL")

EQUAL("EQUAL")

BETWEEN("BETWEEN")

NOT_BETWEEN("NOT_BETWEEN")

ONE_OF("ONE_OF")

REGEX("REGEX")

BEGINS_WITH("BEGINS_WITH")

ENDS_WITH("ENDS_WITH")

CONTAINS("CONTAINS")

IS_NULL("IS_NULL")

IS_NOT_NULL("IS_NOT_NULL")

Optional<List<OperatorArg>> args

Optional arguments that modify operator behavior.

One of the following:

LEFT_INCLUSIVE("LEFT_INCLUSIVE")

RIGHT_INCLUSIVE("RIGHT_INCLUSIVE")

LEFT_EXCLUSIVE("LEFT_EXCLUSIVE")

RIGHT_EXCLUSIVE("RIGHT_EXCLUSIVE")

CASE_INSENSITIVE("CASE_INSENSITIVE")

Optional<List<FilterValue>> right

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

Optional<Value> value

One of the following:

double

String

Optional<Variable> variable

A variable reference.

String name

The variable name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<Modifier> modifier

Optional arithmetic modifier.

List<Arg> args

One of the following:

double

String

ModifierOp name

The modifier operation.

One of the following:

ADD("ADD")

SUBTRACT("SUBTRACT")

Optional<FieldPeriod> period

Optional reporting period.

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

ANNUAL("ANNUAL")

String name

boolean shared

Whether any user may fetch this screener by id.

LocalDateTime updatedAt

Optional<List<FieldRef>> columns

Field references included when running this screener.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

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

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

ANNUAL("ANNUAL")

Optional<FieldType> valueType

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

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

Optional<List<SortSpec>> sorts

FieldRef field

The field to sort by.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

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

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

ANNUAL("ANNUAL")

Optional<FieldType> valueType

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

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

Optional<SortDirection> direction

Sort direction (defaults to DESC).

One of the following:

ASC("ASC")

DESC("DESC")

class ScreenerFilter:

A single filter criterion for the screener.

String field

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

String operator

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

JsonValue value

Filter value

class SearchFilter:

A single filter condition.

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

FieldRef left

The field to filter on.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

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

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

ANNUAL("ANNUAL")

Optional<FieldType> valueType

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

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

Optional<FilterOpSpec> op

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

FilterOperator name

The operator to apply.

One of the following:

LESS_THAN("LESS_THAN")

LESS_OR_EQUAL("LESS_OR_EQUAL")

GREATER_THAN("GREATER_THAN")

GREATER_OR_EQUAL("GREATER_OR_EQUAL")

EQUAL("EQUAL")

BETWEEN("BETWEEN")

NOT_BETWEEN("NOT_BETWEEN")

ONE_OF("ONE_OF")

REGEX("REGEX")

BEGINS_WITH("BEGINS_WITH")

ENDS_WITH("ENDS_WITH")

CONTAINS("CONTAINS")

IS_NULL("IS_NULL")

IS_NOT_NULL("IS_NOT_NULL")

Optional<List<OperatorArg>> args

Optional arguments that modify operator behavior.

One of the following:

LEFT_INCLUSIVE("LEFT_INCLUSIVE")

RIGHT_INCLUSIVE("RIGHT_INCLUSIVE")

LEFT_EXCLUSIVE("LEFT_EXCLUSIVE")

RIGHT_EXCLUSIVE("RIGHT_EXCLUSIVE")

CASE_INSENSITIVE("CASE_INSENSITIVE")

Optional<List<FilterValue>> right

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

Optional<Value> value

One of the following:

double

String

Optional<Variable> variable

A variable reference.

String name

The variable name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<Modifier> modifier

Optional arithmetic modifier.

List<Arg> args

One of the following:

double

String

ModifierOp name

The modifier operation.

One of the following:

ADD("ADD")

SUBTRACT("SUBTRACT")

Optional<FieldPeriod> period

Optional reporting period.

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

ANNUAL("ANNUAL")

class SortSpec:

A sort specification pairing a field with a direction.

FieldRef field

The field to sort by.

String name

The field name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<FieldPeriod> period

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

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

ANNUAL("ANNUAL")

Optional<FieldType> valueType

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

One of the following:

DECIMAL("DECIMAL")

INTEGER("INTEGER")

STRING("STRING")

ANALYST_RATING("ANALYST_RATING")

DATE("DATE")

Optional<SortDirection> direction

Sort direction (defaults to DESC).

One of the following:

ASC("ASC")

DESC("DESC")

class Variable:

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

String name

The variable name.

Optional<FieldLookback> lookback

Optional historical lookback window.

One of the following:

ONE_DAY("ONE_DAY")

ONE_WEEK("ONE_WEEK")

ONE_MONTH("ONE_MONTH")

THREE_MONTHS("THREE_MONTHS")

SIX_MONTHS("SIX_MONTHS")

YEAR_TO_DATE("YEAR_TO_DATE")

ONE_YEAR("ONE_YEAR")

Optional<Modifier> modifier

Optional arithmetic modifier.

List<Arg> args

One of the following:

double

String

ModifierOp name

The modifier operation.

One of the following:

ADD("ADD")

SUBTRACT("SUBTRACT")

Optional<FieldPeriod> period

Optional reporting period.

One of the following:

QUARTER("QUARTER")

TRAILING_TWELVE_MONTHS("TRAILING_TWELVE_MONTHS")

ANNUAL("ANNUAL")

class VariableDef:

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

String description

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

String name

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

String resolvesTo

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