Skip to content
Longport WhaleLongport Whale
Margin Call

Margin Call Detail Pre-Check

Runs a pre-check on the margin-call detail and returns whether the given account is in a margin-call state.

Request parameters

  • Required: aaid (securities account)
  • See the field definitions for each field's format, allowed values, and business meaning.

Returns

On success, returns the pre-check result indicating whether the account is in a margin call, which can be used to decide whether to load the full detail. See the response definition for field meanings.

POSThttps://b-api.lbkrs.com/risk/margin_call_detail_pre_check

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

aaidstringrequired

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.

Responses

HTTP 200OK
Standard response envelopecodemessagedata
dataobjectdata structure
hitboolean

Whether the account hits a margin call.

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