Risk History Record - List

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

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

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_histories' \
  --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>",
        "account_channel": "<string>",
        "aaid": "<string>",
        "alert_type": "<string>",
        "status": "<string>",
        "reason": "<string>",
        "comment": "<string>",
        "alert_date": "<string>",
        "end_date": "<string>",
        "currency": "<string>",
        "net_asset_ratio": "<string>",
        "warning_value": "<string>",
        "total_cash": "<string>",
        "position_value": "<string>",
        "total_asset": "<string>",
        "im_margin": "<string>",
        "mm_margin": "<string>",
        "fm_margin": "<string>"
      }
    ],
    "total": 0
  }
}