File Import

Query import records of corporate-action source files, used to track whether the external files required by clearing and back-office processes were imported successfully.

Request parameters

Combine business filters through filters (see the filters field notes below for the available fields), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Each record corresponds to one imported source file, covering types such as CTF trade files, settlement files, common symbol-information files, and IFAST settlement files. It carries the file name, file type, market, file date (business date), import state, and operator.

The import state reflects the file's processing progress (for example resolved or used successfully), so you can tell whether a given file type for a given business date is ready, or investigate files that failed to import.

Returns

On success, returns the matching record list with pagination info. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/corp_action_source_files

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 above, or the call will be rejected.

Request body application/json

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.

Allowed values: 1 Unresolved, 2 Resolving, 3 Resolved, 4 Fail, 5 Data In Use, 6 Usage Successful, 7 Usage Failed

Values

1: Unresolved
2: Resolving
3: Resolved
4: Fail
5: Data In Use
6: Usage Successful
7: Usage Failed

file_typestring

Filters results by File Type.

Allowed values: 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

Values

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

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/corp_action_source_files' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "162232",
        "file_type": "IB (settlement_iblite_hk)",
        "file_type_val": "96",
        "file_name": "IB LITE 20260702 (1).csv",
        "market": "US",
        "biz_date": "2026-07-02",
        "op_user_id": "user@example.com",
        "state": "Resolved",
        "state_val": "3",
        "created_at": "1784180196",
        "updated_at": "1784180196"
      }
    ],
    "total": 19323
  }
}