Skip to content
Longport WhaleLongport Whale
Fundamentals

Get Security Basic Information

Queries the basic information of the specified security, including the name, company profile, one-line introduction, icon and logo, wiki link, industry, market, security id, symbol and security type. You can query by security id, or by "symbol.market" (for example AAPL.US) to obtain the security id. Used by the IPO prospectus page to choose between the IPO template and the ETF template based on the security type, by the stock detail page to display the one-line company introduction, and to obtain the security id when the stock detail page is opened by stock symbol.

GEThttps://api.lbkrs.com/v1/stock-info/basicinfo

Parameters

counter_idstringquery

Security id, for example ST/HK/1256. Pass either this or ticker_dot_region. If both are omitted, no error is returned, but all fields in the returned data are empty

ticker_dot_regionstringquery

Security symbol in the "symbol.market" format, for example AAPL.US or 1256.HK. Pass either this or counter_id. Used when the stock detail page is opened by stock symbol

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get security basic information” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
namestring

Security name

profilestring

Company (or fund) profile

company_namestring

Company name. May be an empty string

statusstring

Security status, for example normal

introstring

One-line company introduction. May be an empty string

iconstring

Link to the security icon

logostring

Link to the security logo

wiki_urlstring

Link to the security wiki page

industryobject

Industry. null when there is no industry information (for example, for an ETF)

Child attributes
idstring

Industry id (uint64, returned as a string)

namestring

Industry name

counter_idstring

Industry sector id, for example BK/HK/IN20245

dlcobject

Daily Leverage Certificate (DLC) information. Returned only for DLC securities; null for other securities

Child attributes
underlying_typestring

Underlying asset type

underlyingstring

Underlying asset

leveragestring

Leverage ratio

typestring

DLC type

stock_codestring

Security code

isinstring

ISIN code

underlying_counter_idstring

Security id of the underlying asset

marketstring

Market, for example HK or US

counter_idstring

Security id

symbolstring

Security symbol, for example 1256

security_typestring

Security type, consistent with the security id prefix, for example ST for stocks and ETF for exchange-traded funds. The IPO prospectus page uses it to decide between the ETF template (ETF) and the IPO template (other values)

Whale Docs