Skip to content
Longport WhaleLongport Whale
Index Level

Index Level

Query the index-level configuration used by stress testing, for maintaining the stock grade associated with each index.

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 one index-level configuration, carrying the index code, index name, and its associated stock grade.
  • A record also keeps maintenance information such as remark, last editor, and update time.
  • This configuration provides the index-to-stock-grade classification used 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_stress_test_index_levels

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.risk_monitoring_index_list_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
index_codestring

Index Code. Filters results by Index Code.

index_namestring

Index Name. Filters results by Index Name.

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 Index Level 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.

index_codestring

Index Code. Returned value: Index Code.

index_namestring

Index Name. Returned value: Index Name.

stock_levelstring

Stock Grade. Returned value: Stock Grade.

stock_level_valstring

Stock Grade (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.

remarkstring

Remarks. Returned value: Remarks.

operatorstring

Updated By. Returned value: Updated By.

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