Skip to content
Longport Whale
Risk Control Rules Management

Risk Rules Management Export

Export the Risk Rules Management list to a file. In sync mode (mode:0) the download URL is returned directly; in async mode (mode:1) a file_download_id is returned, to be polled via the shared GET/DELETE /v1/datasets/download/{id} endpoint for status and the final download URL.

POSThttps://b-api.longbridge.xyz/v1/datasets/risk_rules/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_rules.yaml (the query capability).

Child attributes
filters.rule_namestring

Rule Name

filters.group_namestring

Risk Control Condition. Options: ignore_margin_call = MarginCall Exemption; over_financing_margin_call_ignore = OverLimit MarginCall Exemption

ignore_margin_callover_financing_margin_call_ignore

filters.rule_typestring

Rule Type. Options: global = Global; personalise = Personalise

globalpersonalise

filters.aaidstring

Client

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

Whale Docs