Sending Brokerage Firm Export

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

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

Child attributes

filters.idstring

filters.updated_atobject

Update Time. Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

filters.updated_at.gtestring

Greater Than or Equal

filters.updated_at.ltestring

Less Than or Equal

filters.marketstring

Market. Options: HK = HK Market; US = US Market; CN = CN Market; SG = SG Market

HKUSCNSG

filters.ticket_operationstring

Audit Status. Options: 0 = Initial; 1 = New to approve; 2 = Edit to approve; 3 = Delete to approve

0123

filters.statestring

Status. Options: 1 = Enabled; 2 = Disabled

12

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/atm_rival_brokers/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>"
  }
}