Skip to content
Industries and Investment Styles

Get Industry Map Tree

Retrieves the industry hierarchy, from industries and sub-industries down to stocks, with change and year-to-date change on every node, for the tree map and list on the industry map page. With type 0, query the industry map by market and industry_id; with type 1, query the peer comparison of the industry a stock belongs to by counter_id, and top returns that industry. It also serves the peer comparison on the security detail page.

GEThttps://api.lbkrs.com/v1/stock-info/industry-map

Parameters

typestringqueryRequired

Query type:

  • 0 - Industry map
  • 1 - Peer comparison of a stock

01

marketstringquery

Market code from markets[].code of Get Industry Map Filters; used when type is 0

industry_idstringquery

Industry ID from industries[].id; used when type is 0

counter_idstringquery

Security ID of the stock; used when type is 1

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Industry Map Tree” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
chainobject

Node of the industry hierarchy

Child attributes
industry_idstring

Industry ID

namestring

Name

codestring

Industry classification code

parent_codestring

Parent industry classification code

levelinteger

Node level

counter_idstring

Security ID of the node: the industry index for an industry node, a stock for a leaf node

marketstring

Market code, for example US or HK

stock_numstring

Number of stocks under the node

chgstring

Price change ratio as a decimal; 0.0123 means 1.23%

ytd_chgstring

Year-to-date change, as a decimal

sharelist_idstring

ID of the linked stock list

nextarray<object>

Child nodes with the same structure

topobject

Industry of the stock; returned only when type is 1

Child attributes
industry_idstring

Industry ID

namestring

Industry name

marketstring

Market code, for example US or HK

Whale Docs