Skip to content
Stock Screener

Search theme screener results

Returns a page of securities that match the main conditions, sub-conditions, and sort order of a theme screener, with the value of each indicator column. The theme screener result list uses it for the first load, condition changes, sorting, and paging. Condition values come from GET /calc/screener/condition/lists. This operation only reads data and has no side effects. If the request fails, the Broker App can keep the loaded results and let the Client retry.

POSThttps://api.lbkrs.com/calc/screener/search

Request body application/json

pageintegerrequired

Page number, starting from 0. Increase it to load the next page

sizeintegerrequired

Page size. The Broker App uses 20

marketstringrequired

Market code, from markets[].code of the theme screener market configuration (GET /calc/screener/market/config)

main_conditionarray<object>required

Main condition values. Include every main condition returned by the condition endpoint

Child attributes
idstringrequired

Main condition ID, from main_conditions[].id

minstring

Lower bound

maxstring

Upper bound

multi_typeinteger

Selected stage type of a multi-value condition. Send 0 for other conditions

sub_conditionarray<string>

IDs of the selected sub-conditions

sort_byinteger

Index of the sort column, starting from 0, matching the position in values[] of the result

sort_orderinteger

Sort direction:

  • 0 - Descending
  • 1 - Ascending
Values
0
1
returnsarray<string>required

Indicator keys to return: the key of every main condition, each non-empty multi_sub_key of multi-value conditions, and the key of each return indicator the Client added

Responses

HTTP 200The request succeeded. The response body contains the result of the “Search theme screener results” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
totalinteger

Total number of matching securities. Use it to decide whether more pages exist

itemsarray<object>

Securities on this page

Child attributes
counter_idstring

Security ID (counter_id)

namestring

Security name

valuesarray<object>

Indicator values per column. The order matches the column index used by sort_by

Child attributes
idstring

Corresponding main condition ID

namestring

Indicator name, used as the column title

valuestring

Indicator value

unitstring

Unit. When %, display value as a percentage

categoryinteger

Value type:

  • 1 - Number
  • 2 - String (display as is)
Values
1
2
signboolean

Whether to show a + sign for positive numbers

neutralboolean

Whether to show the value in a neutral color instead of rise and fall colors

multi_valuesarray<object>

Coordinate series of a multi-value condition. When not empty, this column cannot be sorted

Child attributes
xnumber

X coordinate

ynumber

Y coordinate

Whale Docs