Risk Alert Record Export

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

Filters. Same fields as the filters of risk_alert_logs.yaml (the query capability).

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

orderByarray<object>

Order By

modeinteger

Mode. Defaults to 0 (sync) when omitted.. Options: 0 = Sync; 1 = Async

01

extstring

Ext. Supports csv/xlsx; defaults to csv.

csvxlsx

file_namestring

File Name

remarkstring

Remark

down_fieldsarray<string>

Down Fields. When omitted, all fields are exported; allowed values are listed under items.enum (the same field list as the query endpoint's data.list.items).

ticket_contentstring

Ticket Content. Shown to the approver when the template has a download-approval ticket configured.

ticket_preview_urlstring

Ticket Preview URL

hideinteger

Hide. Options: 0 = Not Hidden; 1 = Hidden

01

Responses

HTTP 200Export result. In sync mode the download URL is returned directly; in async mode a file_download_id is returned for subsequent polling.

Standard response envelopecodemessagedata

dataobjectdata structure

urlstring

Download URL. Returned in sync mode (mode:0); empty in async mode.

file_download_idstring

File Download ID. Returned in async mode (mode:1); used to poll GET/DELETE /v1/datasets/download/{id}.

ticket_idstring

Ticket ID

Request

curl --request POST \
  --url 'https://b-api.longbridge.xyz/v1/datasets/risk_alert_logs/download' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "orderBy": [],
  "mode": 0,
  "ext": "csv",
  "file_name": "",
  "remark": "",
  "down_fields": [],
  "ticket_content": "",
  "ticket_preview_url": "",
  "hide": 0
}'

Response

{
  "code": 0,
  "message": null,
  "data": {
    "url": "<string>",
    "file_download_id": "<string>",
    "ticket_id": "<string>"
  }
}