Skip to content
Longport WhaleLongport Whale
Test Details

Margin Call Pre - Calculation Details

Query the per-customer results of a single Margin Call stress-test run, used by risk control to assess which margin customers would face a margin call under a market decline or a custom scenario.

Request parameters

  • Combine business filters through filters (see the filter field notes below) and use page, page_size, and orderBy for pagination and sorting.
  • Typically pass task_id to target a specific test run, then inspect the customers under it.

Business notes

  • The data comes from the simulated results of a Margin Call stress test; each record represents one customer included in the run.
  • Each record carries customer identifiers (aaid, name, securities account, counter channel, account manager) and whether a margin call has been triggered.
  • It compares the current basis against the simulated basis: total cash, total position value, maintenance margin, Margin Call margin, recall margin, and estimated total equity assets.
  • This lets you judge each customer's margin shortfall and margin-call exposure under the given stress scenario.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.simulation_margin_query_detail_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
task_idstring

Task ID

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
idstring

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

aaidstring

AAID

aaid_valstring

AAID (raw value). Raw value behind field aaid: aaid returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

real_namestring

Name

display_idstring

A/C No.

account_channelstring

Account Channel

margin_call_statusstring

Margin Call

member_idstring

Member ID

book_cashstring

Total Cash (Current)

position_valuestring

Total MV of Holdings (Current)

current_mmarginstring

MM Requirement (Current)

mcm_marginstring

Margin Requirements(Current)

warning_valuestring

Margin Call Amount (Current)

est_position_valuestring

Total MV of Holdings (Simulated)

mmarginstring

MM Requirement (Simulated)

est_mcm_marginstring

Margin Requirements (Simulated)

est_warning_valuestring

Margin Call Amount (Simulated)

est_total_assetstring

Est. Equity Balance

managerstring

AE

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