Risk Alert Record

Queries Risk Alert Record 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_logs

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. Combines business filters. Omit a filter field to disable that filter.

Child attributes

aaidstring

Client. Filters results by Client.

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.

MarginCall · Margin CallForceCall · Forceselling CallOverFinancingCall · Over Financing Call (Financing > Credit Limit)OptionExerciseCall · Option Exercise Force CallOptionExerciseMarginCall · Option Exercise Margin CallDebtMarginCall · Debt MarginCallOptionOverFinancingCall · Option Over Financing Call (Financing > Credit Limit)

statusstring

Status. Filters results by Status.

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

0 · Pending1 · Follow Up - Pending2 · Completed - Deposit Fund3 · Completed - Sell Stocks4 · Contacted/ Notified5 · Auto Ended/Completed (System)6 · Ended/Completed (User)7 · Auto Forcesold (Sytem) - Pending8 · Auto Forcesold (Sytem) - Failed10 · Exception11 · Auto Forcesold (Sytem) - Time-out Error

counter_id_list_v2string

Holdings. Filters results by Holdings.

is_contain_doom_optionstring

Include Exercise Date Option. Filters results by Include Exercise Date Option.

true · Yesfalse · No

counter_id_liststring

Exclude Underlying Shares. Filters results by Exclude Underlying Shares.

counter_id_list_v3string

Holding Type. Filters results by Holding Type.

HK · HK - StockUS · US - StockOP/US · US - OptionSG · SG - Stock

end_datestring

Due Date. Filters results by Due Date.

account_typestring

Account Type. Filters results by Account Type.

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

C · Cash ClientM · Margin ClientH · House

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 Alert Record 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.

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.

alert_datestring

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

m_m_trans_into_force_timestring

Turned To Forceselling At. Returned value: Turned To Forceselling 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.

triggered_timestring

Triggered Duration (H). Returned value: Triggered Duration (H). The date or time format follows the value returned by the API.

net_asset_ratiostring

Net Asset Ratio. Returned value: Net Asset Ratio.

warning_valuestring

Margin Call Amount. Returned value: Margin Call Amount.

navstring

NAV. Returned value: NAV.

total_assetstring

ELV. Returned value: ELV.

mm_marginstring

MM Requirement. Returned value: MM Requirement.

position_valuestring

Holding Market Value. Returned value: Holding Market Value.

currencystring

Currency. Returned value: Currency.

account_classstring

Customer Type. Returned value: Customer Type.

account_class_valstring

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

no_doom_margin_statusstring

Alert Type (Excl. 0DTE Options). Returned value: Alert Type (Excl. 0DTE Options).

no_doom_margin_status_valstring

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

triggered_daystring

Day Count. Returned value: Day Count.

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.

option_holding_mm_marginstring

MM (Option %). Returned value: MM (Option %).

is_contain_doom_optionstring

Include 0DTR Option?. Returned value: Indicates whether include 0dtr option?.

is_contain_doom_option_valstring

Include 0DTR Option? (raw value). Raw value of is_contain_doom_option. The is_contain_doom_option field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

im_marginstring

IM Requirement. Returned value: IM Requirement.

ignore_im_marginstring

IM w/o 0DTE Option. Returned value: IM w/o 0DTE Option.

ignore_mm_marginstring

MM w/o 0DTE Option. Returned value: MM w/o 0DTE Option.

ignore_fm_marginstring

FM w/o 0DTE Option. Returned value: FM w/o 0DTE Option.

fm_marginstring

FM Requirement. Returned value: FM Requirement.

counter_id_liststring

Available Counters List. Returned value: Available Counters List.

sub_account_countstring

No of Sub-Accounts. Returned value: No of Sub-Accounts.

namestring

Credit Group. Returned value: Credit Group.

real_namestring

Name. Returned value: Name.

long_suspend_market_valuestring

MV of Suspended Shares. Returned value: MV of Suspended Shares.

net_current_assetsstring

Net Liquid Assets. Returned value: Net Liquid Assets.

nlvmmstring

NAV/MM. Returned value: NAV/MM.

navmmstring

ELV/MM. Returned value: ELV/MM.

broker_codestring

AE Cd. Returned value: AE Cd.

margin_limitstring

Margin Limit. Returned value: Margin Limit.

over_limitstring

Over Limit. Returned value: Over Limit.

intereststring

Accrued Interest and Service Charge. Returned value: Accrued Interest and Service Charge.

trading_limitstring

Trading Limit. Returned value: Trading Limit.

total_cashstring

Total Cash. Returned value: Total Cash.

account_typestring

Account Type. Returned value: Account Type.

account_type_valstring

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

force_timestring

Auto force sell time. Returned value: Auto force sell time. The date or time format follows the value returned by the API.

order_created_atstring

Last Force Close Time. Returned value: Last Force Close Time. The date or time format follows the value returned by the API.

migratestring

Is New System. Returned value: Is New System.

existstring

Exis multi leg. Returned value: Exis multi leg.

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_logs' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={"aaid":"H00000000","alert_date":"1781818602","alert_type":"OptionOverFinancingCall","status":"0","counter_id_list_v2":"ST/US/TSLA","is_contain_doom_option":"true","counter_id_list":"ST/US/TSLA","counter_id_list_v3":"ST/US/TSLA,OP/US","end_date":"1782280800","account_type":"M","id":"834435"}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20' \
  --data-urlencode 'orderBy=[]'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "string",
        "aaid": "string",
        "aaid_val": "string",
        "alert_type": "string",
        "alert_type_val": "string",
        "alert_date": "string",
        "m_m_trans_into_force_time": "string",
        "end_date": "string",
        "triggered_time": "string",
        "net_asset_ratio": "string",
        "warning_value": "string",
        "nav": "string",
        "total_asset": "string",
        "mm_margin": "string",
        "position_value": "string",
        "currency": "string",
        "account_class": "string",
        "account_class_val": "string",
        "no_doom_margin_status": "string",
        "no_doom_margin_status_val": "string",
        "triggered_day": "string",
        "status": "string",
        "status_val": "string",
        "reason": "string",
        "reason_val": "string",
        "comment": "string",
        "option_holding_mm_margin": "string",
        "is_contain_doom_option": "string",
        "is_contain_doom_option_val": "string",
        "im_margin": "string",
        "ignore_im_margin": "string",
        "ignore_mm_margin": "string",
        "ignore_fm_margin": "string",
        "fm_margin": "string",
        "counter_id_list": "string",
        "sub_account_count": "string",
        "name": "string",
        "real_name": "string",
        "long_suspend_market_value": "string",
        "net_current_assets": "string",
        "nlvmm": "string",
        "navmm": "string",
        "broker_code": "string",
        "margin_limit": "string",
        "over_limit": "string",
        "interest": "string",
        "trading_limit": "string",
        "total_cash": "string",
        "account_type": "string",
        "account_type_val": "string",
        "force_time": "string",
        "order_created_at": "string",
        "migrate": "string",
        "exist": "string"
      }
    ],
    "total": 0
  }
}