Margin Call Snapshot

Queries Margin Alert Record Snapshot data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

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

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_history_query

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

Query parameters

filtersobject

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

Child attributes

aaidstring

Client. Filters results by Client.

backup_reasonstring

Backup Reason. Filters results by Backup Reason.

FirstMarginCall · First Day Margin CallFirstForceCall · First Day Forceselling CallEndMarginCall · End Day Margin CallEndForceCall · End Day Forceselling CallDailyRecord · Daily RecordPushAppMsg · App Push NotifPushEmailMsg · Email NotifPushSmsMsg · SMS NotifForceCallToMarginCall · 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.

true · Truefalse · 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 --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/risk_alert_log_backups' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20' \
  --data-urlencode 'orderBy=[]'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "9287091",
        "account_channel": "lb",
        "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
  }
}