Skip to content
Stock Overview

Get stock overview summary

Return, in one call, the aggregated summary at the top of the stock Overview: ranking tags, the industry sector and its top-level node in the industry tree, related concept sectors, and investment style (style index, size score, style score, grid position). Used by the summary at the top of the stock detail Overview. The Broker App then queries quotes by the industry and concept sector counter_id.

Community watchlist content in the response is not covered by this document.

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

Parameters

counter_idstringqueryRequired

Stock counter_id, such as ST/US/AAPL

limitintegerqueryRequired

Maximum number of related items; the Broker App passes 3

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get stock overview summary” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
ratingimapobject

Score and style information

Child attributes
style_indexobject

Investment style

Child attributes
counter_idstring

Style index counter_id

namestring

Style index name

changestring

Style index price change as a decimal, such as 0.0123 for 1.23%

scalestring

Size score

stylestring

Style score

invest_style_gridinteger

Position number in the investment style grid

topobject

Top-level node of the industry in the industry tree

Child attributes
namestring

Top-level industry name

industry_idstring

Top-level industry ID

marketstring

Market

rank_tagsobject

Ranking tags

Child attributes
listsarray<object>

Ranking tags

Child attributes
keystring

Ranking list key

titlestring

Ranking list name

textstring

Tag text, such as "No. 1 by attention"

highlight_textstring

Part of the tag text to highlight

rank_typeinteger

Ranking list type:

  • 0 - Popular ranking list
  • 1 - Platform ranking list
Values
0
1
rank_confobject

Ranking list location, used to open the corresponding ranking

Child attributes
marketstring

Market: US US stocks, HK HK stocks, CN China A-shares, SG Singapore

market_namestring

Market name in the request language

first_categorystring

First-level ranking category key, such as gainer

sec_categorystring

Second-level ranking category key, such as within_days

industry_indexobject

Industry or concept sector

Child attributes
counter_idstring

Industry or concept sector counter_id, usable to query the sector quote

namestring

Sector name

rise_numstring

Number of rising stocks in the sector

fall_numstring

Number of falling stocks in the sector

rankinteger

Ranking of the current stock by price change within the sector

stock_numinteger

Number of stocks in the sector

concept_indexobject

Related concept sectors

Child attributes
totalinteger

Total number of related concept sectors

stock_namestring

Current stock name

listarray<object>

Related concept sectors

Child attributes
counter_idstring

Industry or concept sector counter_id, usable to query the sector quote

namestring

Sector name

rise_numstring

Number of rising stocks in the sector

fall_numstring

Number of falling stocks in the sector

rankinteger

Ranking of the current stock by price change within the sector

stock_numinteger

Number of stocks in the sector

Whale Docs