Skip to content
Longport WhaleLongport Whale
Stock Index

Stock Index

Query the mapping of stocks to indices, used by risk control to grade individual stocks by index level.

Request parameters

  • Combine business filters through filters (see the filter field notes below) and use page, page_size, and orderBy for pagination and sorting.

Business notes

  • Each record represents the membership of one stock in a given index.
  • A record carries the stock code, stock name, the index code and index name it belongs to, and the stock grade derived from that index.
  • A record also keeps maintenance information such as last editor and update time.
  • Combined with the index-level configuration, it maps each stock to a unified stock grade for use by stress testing and concentration risk testing.

Returns

On success, returns the matching records with pagination. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/risk_stock_indices

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_margin_call.risk_monitoring_stock_index_query

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
counter_idstring

Counter Id. Filters results by Counter Id. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

s.index_codestring

S Index Code. Filters results by S Index Code.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Stock Index records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

counter_idstring

Counter Id. Returned value: Counter Id.

stock_namestring

Stock Name. Returned value: Stock Name.

index_codestring

Index Code. Returned value: Index Code.

index_namestring

Index Name. Returned value: Index Name.

stock_levelstring

Stock Level. Returned value: Stock Level.

stock_level_valstring

Stock Level (raw value). Raw value of stock_level. The stock_level field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

operatorstring

Operator. Returned value: Operator.

updated_atstring

Updated At. Returned value: Updated At. The date or time format follows the value returned by the API.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs