Margin Call Snapshot

Queries snapshot backups of margin-call monitoring records, capturing a client's risk state at each key point in the margin-call and force-close lifecycle.

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

Snapshots are taken at key lifecycle points; the backup reason covers the first margin call, first force-close, ending, daily archival, App push, and transitions between margin-call and force-close states.
Each record links to an alert record and includes the account, counter channel, snapshot time, alert time, end date, alert type, currency, plus net-asset ratio, required margin, cash, total position value, equity assets, loan-inclusive equity, and the initial/maintenance/force-close margins.
Records also report days overdue and days overdue in the past 30 days, supporting overdue tracking.
Filter by client, backup reason, alert record, overdue flag, and record date.

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_log_backups

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.margin_call_history_query

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes

aaidstring

Client. Filters results by 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.

backup_reasonstring

Backup Reason. Filters results by Backup Reason.

Allowed values: FirstMarginCall First Day Margin Call, FirstForceCall First Day Forceselling Call, EndMarginCall End Day Margin Call, EndForceCall End Day Forceselling Call, DailyRecord Daily Record, PushAppMsg App Push Notif, PushEmailMsg Email Notif, PushSmsMsg SMS Notif, ForceCallToMarginCall Turn to Margin Call (From Forceselling Call), MarginCallToForceCall Turn to Forceselling Call (From Margin Call)

Values

FirstMarginCall: First Day Margin Call
FirstForceCall: First Day Forceselling Call
EndMarginCall: End Day Margin Call
EndForceCall: End Day Forceselling Call
DailyRecord: Daily Record
PushAppMsg: App Push Notif
PushEmailMsg: Email Notif
PushSmsMsg: SMS Notif
ForceCallToMarginCall: Turn to Margin Call (From Forceselling Call)
MarginCallToForceCall: Turn to Forceselling Call (From Margin Call)

risk_monitoring_log_idstring

Alert History. Filters results by Alert History.

is_day_of_overduestring

Overdue. Filters results by Overdue.

Allowed values: true, false

Values

true: True
false: False

created_atobject

Created At. Filters results by Created At.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Margin Alert Record Snapshot records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

idstring

ID. Returned value: Unique identifier of the current record.

account_channelstring

Account Channel. Returned value: Account Channel.

risk_monitoring_log_idstring

Alert ID. Returned value: Alert ID.

aaidstring

A/C No. Returned value: A/C No.

aaid_valstring

A/C No (raw value). Raw value of aaid. The aaid field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Created At. Returned value: Created At. The date or time format follows the value returned by the API.

alert_datestring

Triggered At. Returned value: Triggered At. The date or time format follows the value returned by the API.

end_datestring

Due Date. Returned value: Due Date. The date or time format follows the value returned by the API.

alert_typestring

Alert Type. Returned value: Alert Type.

alert_type_valstring

Alert Type (raw value). Raw value of alert_type. The alert_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

backup_reasonstring

Identified Root Cause. Returned value: Identified Root Cause.

backup_reason_valstring

Identified Root Cause (raw value). Raw value of backup_reason. The backup_reason field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

currencystring

Currency. Returned value: Currency.

net_asset_ratiostring

Net Asset Ratio. Returned value: Net Asset Ratio.

warning_valuestring

Margin Call Amount. Returned value: Margin Call Amount.

total_cashstring

Available Cash. Returned value: Available Cash.

position_valuestring

MV of Holdings. Returned value: MV of Holdings.

navstring

Equity Balance. Returned value: Equity Balance.

total_assetstring

ELV. Returned value: ELV.

im_marginstring

IM Margin. Returned value: IM Margin.

mm_marginstring

MM Margin. Returned value: MM Margin.

fm_marginstring

FM Margin. Returned value: FM Margin.

day_of_overduestring

Days of Overdue. Returned value: Days of Overdue.

day_of_overdue_in_the_past_30_daysstring

Days of Overdue In The Past 30 Days. Returned value: Days of Overdue In The Past 30 Days.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/risk_alert_log_backups' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "9287091",
        "account_channel": "longport_test",
        "risk_monitoring_log_id": "834619",
        "aaid": "H00000000",
        "aaid_val": "10000000",
        "created_at": "1784182667",
        "alert_date": "1784182652",
        "end_date": "1784628000",
        "alert_type": "Margin Call",
        "alert_type_val": "MarginCall",
        "backup_reason": "End Day Margin Call",
        "backup_reason_val": "EndMarginCall",
        "currency": "HKD",
        "net_asset_ratio": "85.02",
        "warning_value": "0.00",
        "total_cash": "6,229,063.66",
        "position_value": "-3,366,703.31",
        "nav": "2,862,360.354",
        "total_asset": "2,862,360.354",
        "im_margin": "3,030,032.97",
        "mm_margin": "2,693,362.64",
        "fm_margin": "2,356,692.31",
        "day_of_overdue": "",
        "day_of_overdue_in_the_past_30_days": ""
      }
    ],
    "total": 2565043
  }
}