Skip to content
Hypothetical Stress Test Price Decline

Hypothetical Stress Test Price Decline

Query position market value aggregated by stock tier under a hypothetical stress test, used to assess position exposure under an assumed price-drop scenario.

Request parameters

  • This dataset has no business filter fields; pass an empty object for filters. You can still use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • The data corresponds to a stress-test scope: under an assumed price-drop scenario (x%), positions are aggregated by stock tier (stock_level, such as Tier 1/Tier 2).
  • Each record carries the stock tier, currency, total stock quantity, total market value and its ratio, along with the snapshot date and update time.
  • Used for risk stress testing to gauge the scale and concentration of each tier's positions under the assumed drop.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.risk_monitoring_stock_level_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.

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 ELC Position Details 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.

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.

stock_sumstring

Total Market Value of Stock Level. Returned value: Total Market Value of Stock Level.

total_market_valuestring

Collateral Pool Total Market Value. Returned value: Collateral Pool Total Market Value.

ratiostring

Ratio (%). Returned value: Ratio (%).

currencystring

Currency. Returned value: Currency.

created_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