Skip to content
Stock Screener

Search Stocks by Screener Conditions

Returns the stocks that match the market, industry, and indicator conditions, together with the requested indicator values. It supports pagination and sorting by indicator. On the conditions page, send size as 1 and read only total to show the live result count. On the results page, page through with page; fewer items than size means there is no more data. Do not send the request when both filters and industry are empty. Strategy results opened from the daily market report also use this endpoint.

POSThttps://api.lbkrs.com/v1/calc/filter/search

Request body application/json

idstring

Strategy ID. Required when you update a strategy; optional for search and create

namestring

Strategy name. Required when you create or update a strategy

typeinteger

Source of the conditions:

  • 0 - From a recommended strategy
  • 1 - From a Client strategy
  • 2 - New conditions
Values
0
1
2
marketstringrequired

Market code, for example US or HK

industrystring

Industry ID from industries[].id of Get Screener Industries, sent as a string. Omit it for all industries

filtersarray<object>required

Filter conditions, excluding market and industry

Child attributes
keystringrequired

Indicator key. Use indicators[].key for a regular or technical indicator, and the selected sub_indicators[].key for an indicator group

minstring

Lower bound; omit it or send an empty string for no lower bound

maxstring

Upper bound; omit it or send an empty string for no upper bound

tech_valuesobject

Technical indicator parameters. Each key is a tech_key and each value is the selected item_value or the value the Client entered. Send it only for technical indicator conditions

returnsarray<string>required

Indicator keys to return. They determine the content and order of indicators in each result. Put filter_prevclose (previous close) and filter_prevchg (change) first, then add the keys of regular and indicator-group conditions. Do not add technical indicators

pageinteger

Page number, starting from 0

sizeinteger

Number of items per page

sort_byinteger

Sort column: the zero-based index of the sort indicator in returns

sort_orderinteger

Sort direction:

  • 0 - Ascending
  • 1 - Descending
Values
0
1

Responses

HTTP 200The request succeeded. The response body contains the result of the “Search Stocks by Screener Conditions” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
totalinteger

Total number of matching securities

itemsarray<object>

Results on the current page

Child attributes
counter_idstring

Security ID (counter_id)

namestring

Security name

indicatorsarray<object>

Indicator values in the same order as the requested returns

Child attributes
idstring

Indicator ID. -1 is the market condition and -2 is the industry condition; for these, value holds the market code or industry ID

keystring

Indicator key, for example filter_prevchg (change), filter_market (market), or filter_industry (industry)

namestring

Indicator name; for market and industry conditions, the market or industry name

valuestring

Indicator value. In search results, the value for the security; in strategy conditions, used only by market and industry conditions

minstring

Lower bound of the condition range; an empty string means no lower bound

maxstring

Upper bound of the condition range; an empty string means no upper bound

unitstring

Indicator unit

tech_valuesobject

Technical indicator parameters. Each key is a tech_key and each value is the selected item_value or the value the Client entered. Send it only for technical indicator conditions

tech_dataarray<object>

Saved technical parameter details. Rebuild tech_values from them when tech_values is empty

Child attributes
tech_keystring

Technical parameter key, matching tech_indicators[].tech_key in the indicator configuration

tech_namestring

Technical parameter name

tech_item_namestring

Display name of the selected option

tech_item_valuestring

Value of the selected option; put it back into tech_values of the filter

tech_item_prefixstring

Display prefix for a custom input value. When present, display the prefix followed by tech_item_value; otherwise display tech_item_name

Whale Docs