Skip to content
Industry and Supply Chains

Get Supply Chain Relations of a Stock

Returns an overview of the stock's upstream, downstream, and competitive relations, grouped by relation type (such as suppliers, customers, and competitors). Each group lists related companies and their values. Use it for the upstream and downstream tab of the industry chain atlas on the stock Profile page and for the competitor list. When access is not 0, show the matching prompt from access_msg instead of the detail entry.

GEThttps://api.lbkrs.com/v2/stock-info/supply_chains

Parameters

counter_idstringqueryRequired

Security ID (counter_id), such as ST/US/AAPL

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Supply Chain Relations of a Stock” operation.
Standard response envelopecodemessagedata
dataobjectdata structure

Supply chain overview

chainsarray<object>

Relation groups

Child attributes
kindstring

Relation type identifier. Pass it as rel_type to Get Supply Chain Relation Details.

namestring

Group name, such as suppliers, customers, or competitors

value_kindinteger

Meaning of chains[].value:

  • 1 - Three-month price change (competitors)
  • 2 - Business relevance (suppliers and customers)
  • 3 - Data source
Values
1
2
3
chainsarray<object>

Related companies in the group

Child attributes
idstring

Relation record ID

target_counter_idstring

Security ID of the related company

target_namestring

Related company name

valuestring

Value column. Its meaning depends on the group's value_kind.

sourcestring

Data source

accessinteger

The current user's access state for supply chain data:

  • -1 - Disabled
  • 0 - Available
  • 1 - No permission
  • 2 - Trial available

When not 0, show the matching text from access_msg.

Values
-1
0
1
2
access_msgobject

Supply chain access prompts

Child attributes
visitorstring

Prompt for access=1 when the user is not signed in

limitstring

Prompt for access=1 when the user is signed in

trystring

Prompt for access=2

forbiddenstring

Prompt for access=-1

Whale Docs