Skip to content
Longport WhaleLongport Whale
Margin Call History

History Details

Queries a single client's margin-call alert history detail, the alert drill-down for a bad-credit client.

Request parameters

  • Combine business filters through filters (see the filter field descriptions below), and use page, page_size, and orderBy for pagination and sorting.

Business notes

  • The data comes from risk monitoring records joined with force-close records; each record represents one historical alert for the client.
  • Each record includes the alert ID, amount to be called, trigger time, end time, elapsed days, and result flags such as whether the force-close line was touched and whether a force-close occurred, plus status.
  • Typically queried by client (aaid) to review the handling and outcome of each of a client's past alerts.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.margin_call_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

Aaid

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
idstring

Alert ID

warning_valuestring

Margin Call Amount

alert_datestring

Warning Date

end_datestring

End Date

durationstring

Cumulative Days

has_related_recordsstring

Force Sell Flag

has_related_records_valstring

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

is_force_flagstring

Force Call Flag

is_force_flag_valstring

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

statusstring

Status

status_valstring

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

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