Skip to content
Longport WhaleLongport Whale
Margin Call

Risk Alert Record Summary

Query the Risk Alert Record Summary.

GEThttps://b-api.longbridge.xyz/v1/datasets/risk_alert_log_stats

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

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 below, or the call will be rejected.

Query parameters

filtersobject

Filters

Child attributes
aaidstring

Client

alert_datestring

Triggered At

alert_typestring

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

MarginCallForceCallOverFinancingCallOptionExerciseCallOptionExerciseMarginCallDebtMarginCallOptionOverFinancingCall

statusstring

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

0123456781011

counter_id_list_v2string

Holdings

is_contain_doom_optionstring

Include Exercise Date Option

truefalse

counter_id_liststring

Exclude Underlying Shares

counter_id_list_v3string

Holding Type

HKUSOP/USSG

end_datestring

Due Date

account_typestring

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

CMH

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