Skip to content
Longport Whale
Contract

Virtual Asset Contract Export

Export the Virtual Asset Contract 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/booking_va_contracts/download

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

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

Child attributes
filters.falsestring

Contract No

filters.aaidstring

Client

filters.contract.trade_dateobject

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

Child attributes
filters.contract.trade_date.gtestring

Greater Than or Equal

filters.contract.trade_date.ltestring

Less Than or Equal

filters.marketstring

Market. Values are dynamically queried from clear_used_market (not fixed); fetch them live via GET /v1/datasets/refs/clearing_config_markets.

filters.counter_idstring

Counter ID

filters.directionstring

Trade Direction. Options: 1 = Buy; 2 = Sell

12

filters.settlement_channelstring

Settlement Channel. Values are dynamically queried from billing_settlement_channel (not fixed); fetch them live via GET /v1/datasets/refs/billing_settlement_channel.

filters.statestring

Status. Options: 2 = To Be Calculated; 3 = To Be Charged; 4 = To Be Settled; 5 = Settlement Completed; 6 = Equity settled; 1 = Init; -1 = --

234561-1

filters.currencystring

Currency. Values are dynamically queried from global_currency (not fixed); fetch them live via GET /v1/datasets/refs/tenant_currencies.

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