Risk History Record - List

Queries the historical margin-call alert records, used by the risk team to review closed or past margin-call and force-close alert events.

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

Each record represents a single alert event for one client, including the alert type (such as Margin Call, Debt MarginCall, or Force Call), current status, alert date, and end date.
Each record also carries the capital figures for that alert: required margin to be called, net-asset ratio, cash, total position value, loan-inclusive equity, and the initial, maintenance, and force-close margin figures.
Filter by client, alert date, alert type (multi-select), and status to compile and review historical 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_histories

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.

alert_datestring

Triggered At. Filters results by Triggered At.

alert_typestring

Alert Type. Filters results by Alert Type.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: MarginCall Margin Call, ForceCall Forceselling Call, OverFinancingCall Over Financing Call (Financing > Credit Limit), OptionExerciseCall Option Exercise Force Call, OptionExerciseMarginCall Option Exercise Margin Call, DebtMarginCall Debt MarginCall, OptionOverFinancingCall Option Over Financing Call (Financing > Credit Limit)

Values

MarginCall: Margin Call
ForceCall: Forceselling Call
OverFinancingCall: Over Financing Call (Financing > Credit Limit)
OptionExerciseCall: Option Exercise Force Call
OptionExerciseMarginCall: Option Exercise Margin Call
DebtMarginCall: Debt MarginCall
OptionOverFinancingCall: Option Over Financing Call (Financing > Credit Limit)

statusstring

Status. Filters results by Status.

Allowed values: 0 Pending, 1 Follow Up - Pending, 2 Completed - Deposit Fund, 3 Completed - Sell Stocks, 4 Contacted/ Notified, 5 Auto Ended/Completed (System), 6 Ended/Completed (User), 7 Auto Forcesold (Sytem) - Pending, 8 Auto Forcesold (Sytem) - Failed, 10 Exception, 11 Auto Forcesold (Sytem) - Time-out Error

Values

0: Pending
1: Follow Up - Pending
2: Completed - Deposit Fund
3: Completed - Sell Stocks
4: Contacted/ Notified
5: Auto Ended/Completed (System)
6: Ended/Completed (User)
7: Auto Forcesold (Sytem) - Pending
8: Auto Forcesold (Sytem) - Failed
10: Exception
11: Auto Forcesold (Sytem) - Time-out Error

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 Risk History Record - List 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

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

account_channelstring

Account Channel. Returned value: Account Channel.

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.

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.

statusstring

Status. Returned value: Status.

status_valstring

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

reasonstring

Identified Root Cause. Returned value: Identified Root Cause.

reason_valstring

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

commentstring

Remarks. Returned value: Remarks.

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.

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

Total Cash. Returned value: Total Cash.

position_valuestring

MV of Holdings. Returned value: MV of Holdings.

total_assetstring

Equity Balance. Returned value: Equity Balance.

im_marginstring

IM Margin. Returned value: IM Margin.

mm_marginstring

MM Margin. Returned value: MM Margin.

fm_marginstring

FM Margin. Returned value: FM Margin.

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_histories' \
  --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": "834619",
        "account_channel": "longport_test",
        "aaid": "H00000000",
        "aaid_val": "10000000",
        "alert_type": "Margin Call",
        "alert_type_val": "MarginCall",
        "status": "Auto Ended/Completed (System)",
        "status_val": "5",
        "reason": "Other",
        "reason_val": "0",
        "comment": "",
        "alert_date": "1784182652",
        "end_date": "1784628000",
        "currency": "HKD",
        "net_asset_ratio": "84.99%",
        "warning_value": "377.41",
        "total_cash": "6,229,063.66",
        "position_value": "-3,367,265.45",
        "total_asset": "2,861,798.21",
        "im_margin": "3,030,538.90",
        "mm_margin": "2,693,812.36",
        "fm_margin": "2,357,085.81"
      }
    ],
    "total": 204
  }
}