Skip to content
Longport WhaleLongport Whale
Test Task List

ELC Short Fall Details

Query per-client liquid-capital shortfall details from the concentration-risk stress test, used to identify clients likely to face funding gaps when collateral value drops.

Request parameters

  • Combine business filters through filters (optional fields are described below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • Data is expanded per client from the latest test task; each record maps to one securities account.
  • Records include currency, loan amount, market value, liquid assets, adjusted net asset value, and the current liquid-capital shortfall.
  • Shortfall is also given for two stress scenarios where collateral value falls 30% and 50%, used to gauge margin-call and forced-liquidation risk under extreme markets.
  • Filter by client (aaid) to focus on a single client's shortfall.

Returns

On success, returns the list of matching records with pagination. See the response schema for column meanings.

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

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

Child attributes
aaidstring

A/C No.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
origin_idstring

A/C No.

currencystring

Currency

loan_amountstring

Loan Amount

market_valuestring

Market Value (based CCY)

liquid_assetstring

Liquid Assect

adj_loanstring

Adj Loan

short_fallstring

Shortfall

thirty_percent_short_fallstring

Shortfall Drop By 30%

fifty_percent_short_fallstring

Shortfall Drop By 50%

totalintegerrequired

Total

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