Bizcode Query Export · Whale Docs

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

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

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

Child attributes

filters.biz_codestring

Biz Code

filters.business_typestring

Asset Type. Options: 6 = Option; 7 = Bond; 2 = Stock; 5 = Fund; 1 = Cash; 4 = Mmf; 8 = Other; 9 = Crypto; 10 = Derivatives

6725148910

filters.transfer_biz_namestring

Biz Code Name

filters.visiblestring

Display to Client. Options: true = Y; false = N

truefalse

filters.business_type_exstring

Business Scenarios. Options: CA = Corporate Action; IP = IPO; PA = Operating Activity; EX = Exchange; SS = Stock Transfer; UN = Fund; ON = Option; SN = Stock; OT = OTC; DW = Deposit&Withdrawal; FE = Fee; VN = Crypto; BN = Bond; TP = Third-party Payment; DN = Derivatives Trading; CT = Cash Transfer

CAIPPAEXSSUNONSNOTDWFEVNBNTPDNCT

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