Skip to content
Longport Whale
Order Management

OrderPots Export

Export the OrderPots 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/holding_orders/download

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

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

Child attributes
filters.aaidstring

AAID

filters.marketstring

Market. Options: US = US; HK = HK; UK = UK; SZ = SZ; SH = SH; SG = SG; OSL = OSL; HAS = HAS

USHKUKSZSHSGOSLHAS

filters.counter_idstring

Please enter stock code

filters.statestring

Order Status. Multi-select; submit as a comma-joined string. Allowed values are listed under enum.. Options: NotReported = Not Reported; VarietiesNotReported = Varieties Not Reported; ReplacedNotReported = Replaced Not Reported; ProtectedNotReported = Protected Not Reported; FilledStatus = Filled Status; WaitToNew = Wait To New; NewStatus = New Status; WaitToReplace = Wait To Replace; PendingReplaceStatus = Pending Replace Status; ReplacedStatus = Replaced Status; PartialFilledStatus = Partial Filled Status; WaitToCancel = Wait To Cancel; PendingCancelStatus = Pending Cancel Status; RejectedStatus = Rejected Status; CanceledStatus = Canceled Status; ExpiredStatus = Expired Status; PartialWithdrawal = Partial Withdrawal; CancelReject = Cancellation Rejected; ModifiedReject = Modification Rejected; TradeCancel = Trade Cancellation; TCRAcknowledgedStatus = To be Confirmed; TCRCanceledStatus = Cancelled; TCRRejectedStatus = Rejected; TCRDealStatus = Confirmed; TCRPartialWithdrawal = PartialWithdrawal

NotReportedVarietiesNotReportedReplacedNotReportedProtectedNotReportedFilledStatusWaitToNewNewStatusWaitToReplacePendingReplaceStatusReplacedStatusPartialFilledStatusWaitToCancelPendingCancelStatusRejectedStatusCanceledStatusExpiredStatusPartialWithdrawalCancelRejectModifiedRejectTradeCancelTCRAcknowledgedStatusTCRCanceledStatusTCRRejectedStatusTCRDealStatusTCRPartialWithdrawal

filters.order_typestring

Order Type. Options: LO = Limit Order; ELO = ELO; MO = Market Order; AO = AO; ALO = ALO; SLO = SLO; LIT,1 = Limit If Touch; LIT,2 = Limit If Touch; TSLPAMT,1 = Trail to Buy; TSLPAMT,2 = Trail to Sell; TSLPPCT,1 = Trail to Buy; TSLPPCT,2 = Trail to Sell; TSMAMT,1 = Trail to Buy; TSMAMT,2 = Trail to Sell; TSMPCT,1 = Trail to Buy; TSMPCT,2 = Trail to Sell; MIT,1 = Buy if Touched; MIT,2 = Sell if Touched; ODD = Odd Lot; SODD = Odd lot matching; M = Manual Trade; O = Odd Lot; P = Pre Opening; DLO = Day Limit Order; MOC = Market On Close

LOELOMOAOALOSLOLIT,1LIT,2TSLPAMT,1TSLPAMT,2TSLPPCT,1TSLPPCT,2TSMAMT,1TSMAMT,2TSMPCT,1TSMPCT,2MIT,1MIT,2ODDSODDMOPDLOMOC

filters.actionstring

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

12

filters.created_atobject

Created At. Range filter; both bounds are optional (omit a bound to leave that side unbounded). Defaults to the range [30 day(s) ago, today] when omitted (gte/lte roll with the request date).

Child attributes
filters.created_at.gtestring

Greater Than or Equal

filters.created_at.ltestring

Less Than or Equal

filters.order_tagstring

Order Tag. Options: 1 = 普通订单; 2 = 长期单; 3 = 暗盘订单; 4 = 强平单; 5 = 线下单; 6 = 行权订单权利方; 7 = 行权订单义务方; 8 = 放弃行权; 9 = 成交分配; 10 = MR test

12345678910

filters.updated_atobject

Updated at. 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.order_idstring

Order Id

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