File Import Settings

Query file-import configuration, used to maintain which file types the back office can import and how they are imported.

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 importable file type, carrying the file type, whether automatic import is enabled, a show/hide flag, and the updater and update time. Automatic import must be enabled through customer service.

Entries are ordered by each file type's historical import frequency from high to low, so the most-used types surface first.

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/file_upload_config

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

Child attributes

upload_cnf_file_typestring

Filters results by File type. Values come from a backend data dictionary.

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

pageinteger

page_sizeinteger

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Child attributes

idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

file_typestring

File type. Returned value: Importable file type (display value; the raw code is in the matching _val field).

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.

admin_idstring

Updated by. Returned value: Back-office user who last updated the config (display value; the raw code is in the matching _val field).

admin_id_valstring

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

updated_atstring

Updated at. Returned value: Unix timestamp in seconds, returned as a string.

is_autostring

Auto import. Returned value: Whether auto import is supported/enabled (display value; the raw code is in the matching _val field).

is_auto_valstring

Raw value behind field is_auto: is_auto returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

is_showstring

Show/Hide. Returned value: Whether the file type is shown, as the string true or false.

totalintegerrequired

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/file_upload_config' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "file_type": "1",
        "file_type_val": "1",
        "admin_id": "1000000001",
        "admin_id_val": "1",
        "updated_at": "1789713827",
        "is_auto": "1",
        "is_auto_val": "1",
        "is_show": "1"
      }
    ],
    "total": 1
  }
}