Risk Alert Record · Whale Docs

POSThttps://b-api.longbridge.xyz/v1/datasets/risk_alert_logs

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters

Child attributes

filters.aaidstring

Client

filters.alert_datestring

Triggered At

filters.alert_typestring

Alert Type. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 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)

MarginCallForceCallOverFinancingCallOptionExerciseCallOptionExerciseMarginCallDebtMarginCallOptionOverFinancingCall

filters.statusstring

Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: 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

0123456781011

filters.counter_id_list_v2string

Holdings

filters.is_contain_doom_optionstring

Include Exercise Date Option. Options: true = True; false = 否

truefalse

filters.counter_id_liststring

Exclude Underlying Shares

filters.counter_id_list_v3string

Holding Type. Options: HK = HK - Stock; US = US - Stock; OP/US = US - Option; SG = SG - Stock

HKUSOP/USSG

filters.end_datestring

Due Date

filters.account_typestring

Account Type. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: C = Cash Client; M = Margin Client; H = House

CMH

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

totalintegerrequired

Total

Request

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

Response

{
  "code": 0,
  "message": null,
  "data": {
    "list": [
      {
        "id": "<string>",
        "aaid": "<string>",
        "alert_type": "<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>",
        "no_doom_margin_status": "<string>",
        "triggered_day": "<string>",
        "status": "<string>",
        "reason": "<string>",
        "comment": "<string>",
        "option_holding_mm_margin": "<string>",
        "is_contain_doom_option": "<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>",
        "force_time": "<string>",
        "order_created_at": "<string>",
        "migrate": "<string>",
        "exist": "<string>"
      }
    ],
    "total": 0
  }
}