Skip to content
Longport WhaleLongport Whale
Margin Call

Risk Alert Record Exception Ticket

Returns the abnormal entries among risk alert records, used by risk control to investigate margin call alerts flagged as abnormal.

Request parameters

  • Combine business filters through filters (optional fields are listed in the filter field descriptions below), and use page, page_size, and orderBy for pagination and sorting.

Business notes

The data shares the same source as the real-time alert records but lists only alerts identified as abnormal, carrying the client and account number, alert type and status, root cause, margin call amount, the various margin requirements and net asset ratio, total holding market value, and closable counters.

It supports filtering by client, alert date, alert type, status, and holdings for manual review.

Returns

On success, returns the matching records with pagination info. See the response definition for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

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

Client

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.

alert_datestring

Alert Date

alert_typestring

Alert Type

Allowed values: MarginCall Margin call alert, ForceCall Forced liquidation alert, OverFinancingCall Over-financing alert, OptionExerciseCall Option exercise alert (liquidation), OptionExerciseMarginCall Option exercise alert (margin call), DebtMarginCall Borrowed-coin margin call (or other), OptionOverFinancingCall Option exercise alert (over-financing)

Values
MarginCall
ForceCall
OverFinancingCall
OptionExerciseCall
OptionExerciseMarginCall
DebtMarginCall
OptionOverFinancingCall
statusstring

Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.

Values
0
1
2
3
4
5
6
7
8
10
11
counter_idstring

Counter Id. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

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

Id

account_channelstring

Account Channel

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.

alert_typestring

Alert Type

alert_type_valstring

Alert Type (raw value). Raw value behind field alert_type: alert_type 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.

reasonstring

Reason

reason_valstring

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

commentstring

Comment

alert_datestring

Alert Date

end_datestring

Due Date

triggered_timestring

Margin Call Hours

currencystring

Currency

net_asset_ratiostring

Net Asset Ratio

option_holding_mm_marginstring

MM (Option %)

warning_valuestring

Margin call amount

available_cashstring

Available Cash

position_valuestring

Position Value

total_assetstring

Equity Balance

im_marginstring

IM requirement

mm_marginstring

MM requirement

fm_marginstring

FM requirement

counter_id_liststring

Exclude Counter

sub_account_countstring

Number of sub-accounts

account_classstring

Customer type

account_class_valstring

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

namestring

Credit group

real_namestring

Name

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