Skip to content
Stock Screener

Get theme screener conditions

Returns the main conditions, sub-conditions, and optional return indicators of a screener theme. The theme screener page uses them to render filters after the Client switches themes, and to build the POST /calc/screener/search request. Get the theme ID from the theme list (GET /calc/screener/theme/lists). This operation only reads configuration and has no side effects. If the request fails, the Broker App can keep the previous conditions or show an empty state.

GEThttps://api.lbkrs.com/calc/screener/condition/lists

Parameters

theme_idstringqueryRequired

Screener theme ID, from items[].id of the theme list

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get theme screener conditions” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
main_conditionsarray<object>

Main conditions. Put all of them in main_condition[] when searching

Child attributes
idstring

Condition ID. Send it as main_condition[].id or in sub_condition[] when searching

keystring

Indicator key. Put it in returns[] to return this indicator in the search result

namestring

Condition name

descriptionstring

Condition description. Do not show a description when empty

unitstring

Value unit, such as %

data_typeinteger

Condition type:

  • 1 - Data item
  • 2 - Single value
  • 3 - Multi-value (a stage must be selected; results return multi_values)
Values
1
2
3
default_valueobject

Value range of a screening condition

Child attributes
minstring

Lower bound. An empty string means no lower bound

maxstring

Upper bound. An empty string means no upper bound

multi_typeinteger

Stage type of a multi-value condition. Values come from multi_config[].stage_items[].multi_type. 0 for other conditions

optional_rangearray<object>

Preset ranges the Client can select directly

Child attributes
minstring

Lower bound. An empty string means no lower bound

maxstring

Upper bound. An empty string means no upper bound

multi_typeinteger

Stage type of a multi-value condition. Values come from multi_config[].stage_items[].multi_type. 0 for other conditions

multi_configarray<object>

Stage configuration of a multi-value condition. Returned only when data_type is 3

Child attributes
stage_namestring

Group name

stage_itemsarray<object>

Selectable stages in the group

Child attributes
multi_namestring

Stage name

multi_typeinteger

Stage type. After selection, send it back as multi_type in the search request

multi_light_icon_urlstring

Stage icon URL for the light theme

multi_dark_icon_urlstring

Stage icon URL for the dark theme

multi_sub_keystring

Additional indicator key of a multi-value condition. When not empty, also put it in returns[]

multi_typeinteger

Currently selected stage type of a multi-value condition. When 0, use default_value.multi_type

defaultboolean

Whether the sub-condition is selected by default. In the first search, put the id of each default sub-condition in sub_condition[]

sub_conditionsarray<object>

Sub-conditions. The Client can select several

Child attributes
idstring

Condition ID. Send it as main_condition[].id or in sub_condition[] when searching

keystring

Indicator key. Put it in returns[] to return this indicator in the search result

namestring

Condition name

descriptionstring

Condition description. Do not show a description when empty

unitstring

Value unit, such as %

data_typeinteger

Condition type:

  • 1 - Data item
  • 2 - Single value
  • 3 - Multi-value (a stage must be selected; results return multi_values)
Values
1
2
3
default_valueobject

Value range of a screening condition

Child attributes
minstring

Lower bound. An empty string means no lower bound

maxstring

Upper bound. An empty string means no upper bound

multi_typeinteger

Stage type of a multi-value condition. Values come from multi_config[].stage_items[].multi_type. 0 for other conditions

optional_rangearray<object>

Preset ranges the Client can select directly

Child attributes
minstring

Lower bound. An empty string means no lower bound

maxstring

Upper bound. An empty string means no upper bound

multi_typeinteger

Stage type of a multi-value condition. Values come from multi_config[].stage_items[].multi_type. 0 for other conditions

multi_configarray<object>

Stage configuration of a multi-value condition. Returned only when data_type is 3

Child attributes
stage_namestring

Group name

stage_itemsarray<object>

Selectable stages in the group

Child attributes
multi_namestring

Stage name

multi_typeinteger

Stage type. After selection, send it back as multi_type in the search request

multi_light_icon_urlstring

Stage icon URL for the light theme

multi_dark_icon_urlstring

Stage icon URL for the dark theme

multi_sub_keystring

Additional indicator key of a multi-value condition. When not empty, also put it in returns[]

multi_typeinteger

Currently selected stage type of a multi-value condition. When 0, use default_value.multi_type

defaultboolean

Whether the sub-condition is selected by default. In the first search, put the id of each default sub-condition in sub_condition[]

return_indicatorsarray<object>

Return indicators that can be added

Child attributes
keystring

Indicator key. After selection, put it in returns[]

namestring

Indicator name

Whale Docs