Skip to content
Longport Whale
File import

File Import Export

Export the File Import 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/corp_action_source_files/download

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

filtersobject

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

Child attributes
filters.file_namestring

File Name

filters.statestring

State. Options: 1 = Unresolved; 2 = Resolving; 3 = Resolved; 4 = Fail; 5 = Data In Use; 6 = Usage Successful; 7 = Usage Failed

1234567

filters.file_typestring

File Type. Options: 1 = CCNPT02; 2 = CCNAN05(Trigger Announcement Generation); 3 = CTF Trade File; 4 = CTFCLOSPRIC; 5 = Stock Mapping; 6 = CSC Trade File; 7 = CSESB01; 8 = IB(settlement_ib_hk); 9 = MCD MB GEM; 12 = Daily Statement; 13 = Monthly Statement; 17 = IFAST Trade File; 18 = IFAST Position; 19 = Tiger Trade File; 20 = Tiger Position File; 21 = HGNH Trade File; 22 = HGNH Position File; 10 = Transaction Details; 11 = Holding Details; 15 = Corporate Action Fees Details; 16 = Corporate Action Entitlement Details; 23 = VT Trade File; 24 = VT Position(Manually Holding Reconciliation); 26 = PSPL Trade File; 25 = OTC Trade File; 27 = Zinvest Position File; 28 = Zinvest Trade File; 33 = Valuable US Trade File; 34 = Valuable HK Grey Trade File; 35 = Valuable Position File; 36 = Valuable HK Trade File; 37 = Settled Cash Transaction; 38 = Balance Detail; 41 = Bargain Detail US OP; 39 = Bargain Detail CN; 40 = Bargain Detail SG; 42 = Options Exercise Details; 43 = Stock Margin; 44 = Shortsell Stock Margin; 45 = Daytrade Stock Margin; 29 = Miscellaneous Cash Transaction; 30 = Miscellaneous Portfolio Transaction; 31 = Bargain Detail HK; 32 = Bargain Detail US; 46 = Bargain Summary; 47 = APEX Security Base (FD); 48 = APEX Cash Activity (FD); 49 = APEX Stock Activity (FD); 50 = APEX Position (FD); 51 = APEX Balance (FD); 52 = APEX Trade Activity (FD); 53 = Common Trade File; 54 = CA Event Detail; 55 = PSPL Position; 56 = Atomic Vaults Trade File; 57 = Atomic Vaults Position File; 58 = General Position File; 59 = Common Symbol Information File; 60 = Common Closing Price File; 61 = WRISE Trade File; 62 = APEX Trade File; 63 = APEX Position File; 64 = Viking Trade File; 65 = Viking Position File; 67 = Atomic Vaults Balance File; 68 = GTN Trade File; 69 = GTN Position File; 66 = Options Exercise Summary; 70 = Yuanta Trade File; 71 = Yongfeng Position File; 72 = Atomic Vaults Trade File Options Overnight; 74 = Short Selling Rate File; 75 = IFAST Billing Consolidated 1; 76 = IFAST Sub-Account AUM; 77 = IFAST Billing Consolidated 2; 78 = IFAST Billing; 79 = IFAST Settlement File; 80 = CSC Trade File(Valuable); 73 = APEX Active Transfer Status (FD); 81 = APEX Override Ratios (FD); 82 = APEX Overnight Buying Power Dump (FD); 83 = APEX Short Selling Stocks (FD); 84 = APEX Mandatory Action Report (FD); 85 = APEX Voluntary Action Report (FD); 86 = APEX Margin Call Report (FD); 87 = APEX Daily Exercise Assignment File (FD); 88 = APEX All Account (FD); 89 = APEX Balance Cash And Balance Margin (FD); 90 = APEX Pending Dividend (FD); 91 = APEX Position Breakout Strategy Overnight (FD); 92 = APEX Trades Moved To An Error Account (FD); 93 = Bakkt Execution Confirm File; 94 = Bakkt Position File; 95 = APEX Symbol File; 97 = APEX Cash Activity Report; 98 = APEX Closed Accounts; 99 = APEX Daily Postmaster Returned Mail; 100 = APEX Monthly Postmaster Returned Mail; 101 = APEX Daily Electronic Communication Preference; 102 = APEX Large Trader IDs; 103 = Bakkt Daily Coin Transfers; 96 = IB(settlement_iblite_hk); 104 = Option Corporate Action Entitlement Details; 105 = Option Corporate Action Announcements; 106 = Option Margin Factor; 107 = APEX Fractional Shares Adaption; 108 = CLSA Trade File; 109 = CLSA Position File; 110 = Valuable Option Trade File; 115 = Tiger Trade File 2026; 116 = Tiger Position File 2026

1234567891213171819202122101115162324262527283334353637384139404243444529303132464748495051525354555657585960616263646567686966707172747576777879807381828384858687888990919293949597989910010110210396104105106107108109110115116

filters.biz_datestring

File Date

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