Skip to content
File import

File Import

Query the file import records. Combine business filters through filters, and control pagination with page and page_size.

Response

On success, returns the matching list of records together with pagination information. See each field's documentation for the purpose, allowed values, and dynamic data source of every filter.

GEThttps://b-api.longbridge.xyz/v1/datasets/corp_action_source_files

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_corporate.corporate_query

The Broker ACCESS_TOKEN must be granted the permission below, or the call will be rejected.

Query parameters

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes
file_namestring

Filters results by File Name.

statestring

Filters results by State.

1 · Unresolved2 · Resolving3 · Resolved4 · Fail5 · Data In Use6 · Usage Successful7 · Usage Failed

file_typestring

Filters results by File Type.

1 · CCNPT022 · CCNAN05(Trigger Announcement Generation)3 · CTF Trade File4 · CTFCLOSPRIC5 · Stock Mapping6 · CSC Trade File7 · CSESB018 · IB(settlement_ib_hk)9 · MCD MB GEM12 · Daily Statement13 · Monthly Statement17 · IFAST Trade File18 · IFAST Position19 · Tiger Trade File20 · Tiger Position File21 · HGNH Trade File22 · HGNH Position File10 · Transaction Details11 · Holding Details15 · Corporate Action Fees Details16 · Corporate Action Entitlement Details23 · VT Trade File24 · VT Position(Manually Holding Reconciliation)26 · PSPL Trade File25 · OTC Trade File27 · Zinvest Position File28 · Zinvest Trade File33 · Valuable US Trade File34 · Valuable HK Grey Trade File35 · Valuable Position File36 · Valuable HK Trade File37 · Settled Cash Transaction38 · Balance Detail41 · Bargain Detail US OP39 · Bargain Detail CN40 · Bargain Detail SG42 · Options Exercise Details43 · Stock Margin44 · Shortsell Stock Margin45 · Daytrade Stock Margin29 · Miscellaneous Cash Transaction30 · Miscellaneous Portfolio Transaction31 · Bargain Detail HK32 · Bargain Detail US46 · Bargain Summary47 · 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 File54 · CA Event Detail55 · PSPL Position56 · Atomic Vaults Trade File57 · Atomic Vaults Position File58 · General Position File59 · Common Symbol Information File60 · Common Closing Price File61 · WRISE Trade File62 · APEX Trade File63 · APEX Position File64 · Viking Trade File65 · Viking Position File67 · Atomic Vaults Balance File68 · GTN Trade File69 · GTN Position File66 · Options Exercise Summary70 · Yuanta Trade File71 · Yongfeng Position File72 · Atomic Vaults Trade File Options Overnight74 · Short Selling Rate File75 · IFAST Billing Consolidated 176 · IFAST Sub-Account AUM77 · IFAST Billing Consolidated 278 · IFAST Billing79 · IFAST Settlement File80 · 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 File94 · Bakkt Position File95 · APEX Symbol File97 · APEX Cash Activity Report98 · APEX Closed Accounts99 · APEX Daily Postmaster Returned Mail100 · APEX Monthly Postmaster Returned Mail101 · APEX Daily Electronic Communication Preference102 · APEX Large Trader IDs103 · Bakkt Daily Coin Transfers96 · IB (settlement_iblite_hk)104 · Option Corporate Action Entitlement Details105 · Option Corporate Action Announcements106 · Option Margin Factor107 · APEX Fractional Shares Adaption108 · CLSA Trade File109 · CLSA Position File110 · Valuable Option Trade File115 · Tiger Trade File 2026116 · Tiger Position File 2026

biz_datestring

Filters results by File Date.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated File Import records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

Returned value: List of list.

Child attributes
idstring

Returned value: Unique identifier of the current record.

file_typestring

Returned value: File Type.

file_type_valstring

Raw value of file_type. The file_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

file_namestring

Returned value: File Name.

marketstring

Returned value: Market.

biz_datestring

Returned value: Biz Date. The date or time format follows the value returned by the API.

op_user_idstring

Returned value: Op User ID.

statestring

Returned value: State.

state_valstring

Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

created_atstring

Returned value: Creat Time. The date or time format follows the value returned by the API.

updated_atstring

Returned value: Updated At. The date or time format follows the value returned by the API.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs