Skip to content
Industry and Supply Chains

Get Supply Chain Relation Details

Returns supply chain details for one relation type: industry, rank, and financial metrics of the current stock (current) and of every related company under that relation (supply_chains). Use it for the comparison page opened from View All in the supply chain section. Set rel_type to chains[].kind from Get Supply Chain Relations of a Stock. When access is not 0, show the matching prompt from access_msg.

GEThttps://api.lbkrs.com/v3/stock-info/supply-chains-detail

Parameters

counter_idstringqueryRequired

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

rel_typestringqueryRequired

Relation type identifier from chains[].kind returned by Get Supply Chain Relations of a Stock

Responses

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

Supply chain relation details

currentobject

Company in a supply chain relation with financial metrics

Child attributes
counter_idstring

Security ID

marketstring

Market

namestring

Company name

rel_typestring

Relation type identifier to the current stock

industry_namestring

Industry

industry_rankstring

Rank within the industry

tagsarray<string>

Tags

currencystring

Currency of financial data

pestring

Price-to-earnings ratio

roestring

Return on equity

net_profit_marginstring

Net profit margin

total_assetsstring

Total assets

salesstring

Revenue

net_incomestring

Net income

debt_assets_ratiostring

Debt-to-assets ratio

leveragestring

Leverage

asset_turnstring

Asset turnover

valuestring

Relation value shown as a percentage by the App. Its meaning matches value_kind of the same group in Get Supply Chain Relations of a Stock.

sourcestring

Data source

supply_chainsarray<object>

Related companies under the relation

Child attributes
counter_idstring

Security ID

marketstring

Market

namestring

Company name

rel_typestring

Relation type identifier to the current stock

industry_namestring

Industry

industry_rankstring

Rank within the industry

tagsarray<string>

Tags

currencystring

Currency of financial data

pestring

Price-to-earnings ratio

roestring

Return on equity

net_profit_marginstring

Net profit margin

total_assetsstring

Total assets

salesstring

Revenue

net_incomestring

Net income

debt_assets_ratiostring

Debt-to-assets ratio

leveragestring

Leverage

asset_turnstring

Asset turnover

valuestring

Relation value shown as a percentage by the App. Its meaning matches value_kind of the same group in Get Supply Chain Relations of a Stock.

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