Skip to content
Longport WhaleLongport Whale
Margin Call

User Order Information

Returns the order 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 order information for the alert record. See the response definition for field meanings.

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

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

Order information.

Child attributes
force_close_orderarray<object>

Force-close order list. May be an empty array.

today_deal_orderarray<object>

Today's filled order list. May be an empty array.

tipsobject

Margin call amount summary (formatted amounts).

Child attributes
val_in_processstring

Amount in process (amount string with thousands separators).

est_reduce_warning_valstring

Estimated reduction of the margin call amount (amount string with thousands separators).

remain_warning_valstring

Remaining margin call amount (amount string with thousands separators).

warning_valstring

Margin call amount (amount string with thousands separators).

origin_tipsobject

Margin call amount summary (raw numbers).

Child attributes
val_in_processstring

Amount in process (numeric string without thousands separators).

est_reduce_warning_valstring

Estimated reduction of the margin call amount (numeric string without thousands separators).

remain_warning_valstring

Remaining margin call amount (numeric string without thousands separators).

warning_valstring

Margin call amount (numeric string without thousands separators).

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