Skip to content
Clear Street Clear Street
Start Trading
API Reference
V1

Screener

Search instruments and manage saved screeners.

Search Screener
$ clst v1:screener search-screener
POST/v1/screener
Get Screeners
$ clst v1:screener get-screeners
GET/v1/saved-screeners
Get Screener By ID
$ clst v1:screener get-screener-by-id
GET/v1/saved-screeners/{screener_id}
Create Screener
$ clst v1:screener create-screener
POST/v1/saved-screeners
Replace Screener
$ clst v1:screener replace-screener
PUT/v1/saved-screeners/{screener_id}
Delete Screener
$ clst v1:screener delete-screener
DELETE/v1/saved-screeners/{screener_id}
ModelsExpand Collapse
field_lookback: "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Historical lookback window for price/change fields.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
field_period: "QUARTER" or "TRAILING_TWELVE_MONTHS"

Reporting period for financial data fields.

"QUARTER"
"TRAILING_TWELVE_MONTHS"
field_ref: object { name, lookback, period, value_type }

A reference to a screener field.

name: string

The field name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
field_type: "DECIMAL" or "INTEGER" or "STRING" or 2 more

The data type of a screener field value.

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
filter_op_spec: object { name, args }

Operator specification with optional behavioral arguments.

name: "LESS_THAN" or "LESS_OR_EQUAL" or "GREATER_THAN" or 11 more

The operator to apply.

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

"LEFT_INCLUSIVE"
"RIGHT_INCLUSIVE"
"LEFT_EXCLUSIVE"
"RIGHT_EXCLUSIVE"
"CASE_INSENSITIVE"
filter_operator: "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.

"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"
filter_value: object { value, variable }

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

value: optional number or string
union_member_0: number
union_member_1: string
variable: optional object { name, lookback, modifier, period }

A variable reference.

name: string

The variable name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
modifier: optional object { args, name }

Optional arithmetic modifier.

args: array of number or string
union_member_0: number
union_member_1: string
name: "ADD" or "SUBTRACT"

The modifier operation.

"ADD"
"SUBTRACT"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

Optional reporting period.

"QUARTER"
"TRAILING_TWELVE_MONTHS"
modifier: object { args, name }

Arithmetic modifier applied to a variable value.

args: array of number or string
union_member_0: number
union_member_1: string
name: "ADD" or "SUBTRACT"

The modifier operation.

"ADD"
"SUBTRACT"
modifier_op: "ADD" or "SUBTRACT"

Modifier operation applied to a variable.

"ADD"
"SUBTRACT"
operator_arg: "LEFT_INCLUSIVE" or "RIGHT_INCLUSIVE" or "LEFT_EXCLUSIVE" or 2 more

Argument that modifies operator behavior.

"LEFT_INCLUSIVE"
"RIGHT_INCLUSIVE"
"LEFT_EXCLUSIVE"
"RIGHT_EXCLUSIVE"
"CASE_INSENSITIVE"
screener_column: object { field, name, value, type }

A single column in the screener search response.

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

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

name: string

The field name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
name: string

Human-readable display name for this field

value: number or string
union_member_0: number
union_member_1: 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.

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

The field to filter on.

name: string

The field name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
op: optional object { name, args }

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

name: "LESS_THAN" or "LESS_OR_EQUAL" or "GREATER_THAN" or 11 more

The operator to apply.

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

"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
union_member_0: number
union_member_1: string
variable: optional object { name, lookback, modifier, period }

A variable reference.

name: string

The variable name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
modifier: optional object { args, name }

Optional arithmetic modifier.

args: array of number or string
union_member_0: number
union_member_1: string
name: "ADD" or "SUBTRACT"

The modifier operation.

"ADD"
"SUBTRACT"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

Optional reporting period.

"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 "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"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 "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
sorts: optional array of SortSpec { field, direction }
field: object { name, lookback, period, value_type }

The field to sort by.

name: string

The field name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
direction: optional "ASC" or "DESC"

Sort direction (defaults to DESC).

"ASC"
"DESC"
screener_entry_list: array of ScreenerEntry { id, created_at, filters, 5 more }
id: string
created_at: string
filters: array of SearchFilter { left, op, right }
left: object { name, lookback, period, value_type }

The field to filter on.

name: string

The field name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
op: optional object { name, args }

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

name: "LESS_THAN" or "LESS_OR_EQUAL" or "GREATER_THAN" or 11 more

The operator to apply.

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

"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
union_member_0: number
union_member_1: string
variable: optional object { name, lookback, modifier, period }

A variable reference.

name: string

The variable name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
modifier: optional object { args, name }

Optional arithmetic modifier.

args: array of number or string
union_member_0: number
union_member_1: string
name: "ADD" or "SUBTRACT"

The modifier operation.

"ADD"
"SUBTRACT"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

Optional reporting period.

"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 "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"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 "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
sorts: optional array of SortSpec { field, direction }
field: object { name, lookback, period, value_type }

The field to sort by.

name: string

The field name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
direction: optional "ASC" or "DESC"

Sort direction (defaults to DESC).

"ASC"
"DESC"
screener_filter: 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

screener_row: array of ScreenerColumn { field, name, value, type }

A single row of screener columns for one instrument.

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

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

name: string

The field name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
name: string

Human-readable display name for this field

value: number or string
union_member_0: number
union_member_1: 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.

screener_row_list: array of ScreenerRow { field, name, value, type }
field: object { name, lookback, period, value_type }

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

name: string

The field name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
name: string

Human-readable display name for this field

value: number or string
union_member_0: number
union_member_1: 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.

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

The field to filter on.

name: string

The field name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
op: optional object { name, args }

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

name: "LESS_THAN" or "LESS_OR_EQUAL" or "GREATER_THAN" or 11 more

The operator to apply.

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

"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
union_member_0: number
union_member_1: string
variable: optional object { name, lookback, modifier, period }

A variable reference.

name: string

The variable name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
modifier: optional object { args, name }

Optional arithmetic modifier.

args: array of number or string
union_member_0: number
union_member_1: string
name: "ADD" or "SUBTRACT"

The modifier operation.

"ADD"
"SUBTRACT"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

Optional reporting period.

"QUARTER"
"TRAILING_TWELVE_MONTHS"
sort_spec: object { field, direction }

A sort specification pairing a field with a direction.

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

The field to sort by.

name: string

The field name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

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

"QUARTER"
"TRAILING_TWELVE_MONTHS"
value_type: optional "DECIMAL" or "INTEGER" or "STRING" or 2 more

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

"DECIMAL"
"INTEGER"
"STRING"
"ANALYST_RATING"
"DATE"
direction: optional "ASC" or "DESC"

Sort direction (defaults to DESC).

"ASC"
"DESC"
variable: object { name, lookback, modifier, period }

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

name: string

The variable name.

lookback: optional "ONE_DAY" or "ONE_WEEK" or "ONE_MONTH" or 4 more

Optional historical lookback window.

"ONE_DAY"
"ONE_WEEK"
"ONE_MONTH"
"THREE_MONTHS"
"SIX_MONTHS"
"YEAR_TO_DATE"
"ONE_YEAR"
modifier: optional object { args, name }

Optional arithmetic modifier.

args: array of number or string
union_member_0: number
union_member_1: string
name: "ADD" or "SUBTRACT"

The modifier operation.

"ADD"
"SUBTRACT"
period: optional "QUARTER" or "TRAILING_TWELVE_MONTHS"

Optional reporting period.

"QUARTER"
"TRAILING_TWELVE_MONTHS"