Skip to content
Search

Search Securities

Searches securities by keyword and returns matching candidates such as stocks, ETFs, indexes, sectors, and funds, including counter_id, code, name, market, currency, product, and ranking score. Use it for search-as-you-type suggestions and search result lists. You can filter by market and product. To load the next page, pass the score and code of the last result on the previous page.

The same operation also serves security switching on the order entry page and the order list, adding securities in the landscape quote view and K-line comparison overlay, choosing stocks when composing a post, and fund search (pass UT as product).

GEThttps://api.lbkrs.com/v1/GetSecurities

Parameters

kstringqueryRequired

Search keyword. Enter a security code, name, English name, or short name

search_srcstringqueryRequired

Source scenario of the search, used to distinguish callers. Known values:

  • main_search - Main search page and fund search
  • quote_horizontal - Search in the landscape quote view
  • security_vs - Adding securities to K-line comparison or industry comparison
  • trade - Switching securities on the order entry page
  • trade_order - Switching securities in the order list
  • post_topic - Choosing stocks when composing a post
marketstringquery

Market filter, such as HK or US. Omit it to search all markets

productstringquery

Product filter. Separate multiple values with commas, such as ST,ETF. Pass UT to search funds only. Broker App passes BK,DLC,ETF,IX,LB,MMF,ST,UT when it does not show warrants or callable bull/bear contracts. Omit it to search all products

is_utbooleanquery

Whether to include funds in the results

scorestringquery

Pagination cursor: the score of the last result on the previous page. Omit it for the first page

codestringquery

Pagination cursor: the code of the last result on the previous page. Pass it together with score. Omit it for the first page

account_channelstringquery

Broker channel

Responses

HTTP 200The request succeeded. The response body contains the result of the “Search securities” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
product_listarray<object>

Matching securities in ranking order. It is an empty array when nothing matches

Child attributes
counter_idstring

Security ID in the format <product>/<market>/<code>, such as ST/US/AAPL. Use it to identify the security in follow-up actions such as opening the security detail page or adding it to a watchlist

codestring

Security code, such as AAPL or 700. Pass it as the code parameter when you load the next page

namestring

Security name in the request language

marketstring

Market of the security, such as HK or US. Broker App uses it to display the market badge

currencystring

Trading currency, such as USD or HKD. For fund results, Broker App displays the currency instead of the market badge

productstring

Security product code, such as ST, ETF, or UT

scorenumber

Ranking score of the result. To load the next page, pass the value from the last result of the previous page as the score parameter

isinstring

International Securities Identification Number (ISIN). For fund results, Broker App displays it instead of the security code; it may be empty for other products

Whale Docs