Skip to content
Longport WhaleLongport Whale
Margin Call

Margin Call User Basic Information

Returns the basic information for the user associated with a margin-call alert record.

Request parameters

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

Returns

On success, returns the user's basic information for the alert record. See the response definition for field meanings.

POSThttps://b-api.lbkrs.com/v1/risk_monitoring/margin_call_basic_info

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.margin_call_detailed

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

risk_monitoring_log_idintegerrequired

Risk Monitoring Log ID

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
dataobject

Basic information of the client for the alert record.

Child attributes
account_channelstring

Counter channel, such as lb.

aaidstring

Internal securities account ID aaid.

display_nostring

Securities account number, such as H00000000.

warning_valuestring

Margin call amount (amount string with thousands separators).

manager_namestring

Account manager name. May be an empty string.

available_cashstring

Available cash.

position_valuestring

Total market value of positions.

total_assetstring

Equity with loan value.

mm_marginstring

Maintenance margin.

fm_marginstring

Force-close margin.

option_asset_ratiostring

Option asset ratio (percentage string).

alert_typestring

Alert type code, such as ForceCall or OptionExerciseMarginCall; same values as the alert type in risk_alert_logs.

end_alert_datestring

Alert deadline in YYYY-MM-DD HH:mm:ss format.

net_asset_ratiostring

Net asset ratio (percentage string).

member_idstring

Client ID member_id.

statusstring

Alert status code (string); same values as the status in risk_alert_logs.

real_namestring

Client name.

im_marginstring

Initial margin.

book_cashstring

Book cash.

nav_marginstring

nav_margin amount (amount string with thousands separators).

exceed_loan_amountstring

Amount of over-financing.

currencystring

Currency of the amount fields, such as HKD.

mcm_marginstring

Margin call margin requirement.

in_debtstring

Debt amount.

fund_market_valuestring

Fund market value.

last_force_close_timestring

Time of the latest force close as a Unix timestamp in seconds.

force_close_countstring

Number of force closes (string).

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