Skip to content
Longport WhaleLongport Whale
Margin Call

Risk Alert Record Summary

Aggregates the margin call amounts of risk alert records by account channel, giving a Margin Call monitoring overview of the total amount to be collected and long-outstanding balances.

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 is aggregated from currently active risk alert records; each row corresponds to one account channel and carries the total margin call amount, shareholder funds, long-outstanding (uncollected) margin call amount, and the primary currency.

It shares the same filter dimensions as the alert detail dataset (client, alert type, status, holdings, and so on) and is used to present overall margin call exposure.

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_log_stats

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

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

Triggered At

alert_typestring

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

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_id_list_v2string

Holdings

is_contain_doom_optionstring

Include Exercise Date Option

Allowed values: true Yes, false No

Values
true
false
counter_id_liststring

Exclude Underlying Shares

counter_id_list_v3string

Holding Type

Allowed values: HK HK stocks, US US stocks, OP/US US options, SG Singapore stocks

Values
HK
US
OP/US
SG
end_datestring

Due Date

account_typestring

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

Values
C
M
H
idstring

Id

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
warning_valuestring

Total Margincall Amount

shareholder_amountstring

Shareholder Amount

recoverable_amount_over_90_daysstring

Longterm Margincall Amount

currencystring

Currency

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