futu_core/
proto_id.rs

1//! FutuOpenD API 协议 ID 常量
2//!
3//! 对应 C++ 中 `FTAPI_Define_ProtoID.h` 的定义。客户端与 OpenD 网关之间的
4//! 通信协议标识。
5//!
6//! **Stable API** — 所有常量均为稳定 ABI，外部 binary 可依赖。新增常量不算
7//! breaking；修改已有常量值 = breaking（C++ 对齐约束下不应发生）。
8
9// ========== 连接管理 ==========
10pub const INIT_CONNECT: u32 = 1001;
11pub const GET_GLOBAL_STATE: u32 = 1002;
12pub const NOTIFY: u32 = 1003;
13pub const KEEP_ALIVE: u32 = 1004;
14
15// ========== 额度查询 ==========
16pub const GET_USED_QUOTA: u32 = 1010;
17
18// ========== 行情协议 ==========
19pub const QOT_SUB: u32 = 3001;
20pub const QOT_REG_QOT_PUSH: u32 = 3002;
21pub const QOT_GET_SUB_INFO: u32 = 3003;
22pub const QOT_GET_BASIC_QOT: u32 = 3004;
23pub const QOT_UPDATE_BASIC_QOT: u32 = 3005;
24pub const QOT_GET_KL: u32 = 3006;
25pub const QOT_UPDATE_KL: u32 = 3007;
26pub const QOT_GET_RT: u32 = 3008;
27pub const QOT_UPDATE_RT: u32 = 3009;
28pub const QOT_GET_TICKER: u32 = 3010;
29pub const QOT_UPDATE_TICKER: u32 = 3011;
30pub const QOT_GET_ORDER_BOOK: u32 = 3012;
31pub const QOT_UPDATE_ORDER_BOOK: u32 = 3013;
32pub const QOT_GET_BROKER: u32 = 3014;
33pub const QOT_UPDATE_BROKER: u32 = 3015;
34pub const QOT_GET_ORDER_DETAIL: u32 = 3016;
35pub const QOT_UPDATE_ORDER_DETAIL: u32 = 3017;
36
37pub const QOT_GET_HISTORY_KL: u32 = 3100;
38pub const QOT_GET_HISTORY_KL_POINTS: u32 = 3101;
39pub const QOT_REQUEST_HISTORY_KL: u32 = 3103;
40
41pub const QOT_GET_TRADE_DATE: u32 = 3200;
42pub const QOT_GET_SUSPEND: u32 = 3201;
43pub const QOT_GET_STATIC_INFO: u32 = 3202;
44pub const QOT_GET_SECURITY_SNAPSHOT: u32 = 3203;
45pub const QOT_GET_PLATE_SET: u32 = 3204;
46pub const QOT_GET_PLATE_SECURITY: u32 = 3205;
47pub const QOT_GET_REFERENCE: u32 = 3206;
48pub const QOT_GET_OWNER_PLATE: u32 = 3207;
49pub const QOT_GET_HOLDING_CHANGE_LIST: u32 = 3208;
50pub const QOT_GET_OPTION_CHAIN: u32 = 3209;
51pub const QOT_GET_REHAB: u32 = 3702;
52
53// 新版 API
54pub const QOT_GET_WARRANT: u32 = 3210;
55pub const QOT_GET_CAPITAL_FLOW: u32 = 3211;
56pub const QOT_GET_CAPITAL_DISTRIBUTION: u32 = 3212;
57pub const QOT_GET_USER_SECURITY: u32 = 3213;
58pub const QOT_MODIFY_USER_SECURITY: u32 = 3214;
59pub const QOT_STOCK_FILTER: u32 = 3215;
60pub const QOT_GET_CODE_CHANGE: u32 = 3216;
61pub const QOT_GET_IPO_LIST: u32 = 3217;
62pub const QOT_GET_FUTURE_INFO: u32 = 3218;
63pub const QOT_REQUEST_TRADE_DATE: u32 = 3219;
64pub const QOT_SET_PRICE_REMINDER: u32 = 3220;
65pub const QOT_GET_PRICE_REMINDER: u32 = 3221;
66pub const QOT_GET_USER_SECURITY_GROUP: u32 = 3222;
67pub const QOT_GET_MARKET_STATE: u32 = 3223;
68pub const QOT_GET_OPTION_EXPIRATION_DATE: u32 = 3224;
69// Futu OpenAPI 10.6 QOT fundamental data / screen APIs.
70pub const QOT_GET_FINANCIALS_EARNINGS_PRICE_MOVE: u32 = 3225;
71pub const QOT_GET_FINANCIALS_EARNINGS_PRICE_HISTORY: u32 = 3226;
72pub const QOT_GET_FINANCIALS_STATEMENTS: u32 = 3227;
73pub const QOT_GET_FINANCIALS_REVENUE_BREAKDOWN: u32 = 3228;
74pub const QOT_GET_RESEARCH_ANALYST_CONSENSUS: u32 = 3229;
75pub const QOT_GET_RESEARCH_RATING_SUMMARY: u32 = 3230;
76pub const QOT_GET_RESEARCH_MORNINGSTAR_REPORT: u32 = 3231;
77pub const QOT_GET_VALUATION_DETAIL: u32 = 3232;
78pub const QOT_GET_VALUATION_PLATE_STOCK_LIST: u32 = 3233;
79pub const QOT_GET_CORPORATE_ACTIONS_DIVIDENDS: u32 = 3234;
80pub const QOT_GET_CORPORATE_ACTIONS_BUYBACKS: u32 = 3235;
81pub const QOT_GET_CORPORATE_ACTIONS_STOCK_SPLITS: u32 = 3236;
82pub const QOT_GET_SHAREHOLDERS_OVERVIEW: u32 = 3237;
83pub const QOT_GET_SHAREHOLDERS_HOLDING_CHANGES: u32 = 3238;
84pub const QOT_GET_SHAREHOLDERS_HOLDER_DETAIL: u32 = 3239;
85pub const QOT_GET_SHAREHOLDERS_INSTITUTIONAL: u32 = 3240;
86pub const QOT_GET_INSIDER_HOLDER_LIST: u32 = 3241;
87pub const QOT_GET_INSIDER_TRADE_LIST: u32 = 3242;
88pub const QOT_GET_COMPANY_PROFILE: u32 = 3243;
89pub const QOT_GET_COMPANY_EXECUTIVES: u32 = 3244;
90pub const QOT_GET_COMPANY_EXECUTIVE_BACKGROUND: u32 = 3245;
91pub const QOT_GET_COMPANY_OPERATIONAL_EFFICIENCY: u32 = 3246;
92pub const QOT_GET_TOP_TEN_BUY_SELL_BROKERS: u32 = 3247;
93pub const QOT_GET_DAILY_SHORT_VOLUME: u32 = 3248;
94pub const QOT_GET_SHORT_INTEREST: u32 = 3249;
95pub const QOT_GET_OPTION_VOLATILITY: u32 = 3250;
96pub const QOT_GET_OPTION_EXERCISE_PROBABILITY: u32 = 3251;
97pub const QOT_STOCK_SCREEN: u32 = 3252;
98pub const QOT_OPTION_SCREEN: u32 = 3253;
99pub const QOT_WARRANT_SCREEN: u32 = 3254;
100pub const QOT_GET_OPTION_QUOTE: u32 = 3255;
101pub const QOT_GET_OPTION_STRATEGY: u32 = 3256;
102pub const QOT_GET_OPTION_STRATEGY_ANALYSIS: u32 = 3257;
103pub const QOT_GET_OPTION_STRATEGY_SPREAD: u32 = 3258;
104pub const QOT_GET_TECHNICAL_UNUSUAL: u32 = 3801;
105pub const QOT_GET_FINANCIAL_UNUSUAL: u32 = 3802;
106pub const QOT_GET_DERIVATIVE_UNUSUAL: u32 = 3803;
107pub const QOT_UPDATE_PRICE_REMINDER: u32 = 3019;
108pub const QOT_REQUEST_HISTORY_KL_QUOTA: u32 = 3104;
109pub const QOT_REQUEST_REHAB: u32 = 3105;
110
111// 其他
112pub const VERIFICATION: u32 = 1006;
113pub const GET_USER_INFO: u32 = 1005;
114pub const GET_DELAY_STATISTICS: u32 = 1007;
115pub const TEST_CMD: u32 = 1008;
116pub const REMOTE_CMD: u32 = 1009;
117
118// NN/MM token enablement and binding-state query, useful for unlock-trade diagnostics.
119pub const GET_TOKEN_STATE: u32 = 1326;
120
121// Risk-free-rate query for option pricing; returns HK / US / JP rates.
122pub const QOT_GET_RISK_FREE_RATE: u32 = 20231;
123
124// Spread-table query for quote price increments.
125pub const QOT_GET_SPREAD_TABLE: u32 = 6503;
126
127// Ticker-statistic summary query.
128pub const QOT_GET_TICKER_STATISTIC: u32 = 6365;
129// Ticker-statistic detail query; returns statistic rows plus pagination metadata.
130pub const QOT_GET_TICKER_STATISTIC_DETAIL: u32 = 6366;
131
132// ========== 交易协议 ==========
133pub const TRD_GET_ACC_LIST: u32 = 2001;
134pub const TRD_UNLOCK_TRADE: u32 = 2005;
135pub const TRD_SUB_ACC_PUSH: u32 = 2008;
136
137/// Daemon-internal proto_id for `/api/unsub-acc-push`.
138///
139/// **不是真 backend cmd_id** — backend `Trd_SubAccPush` proto 只有
140/// `acc_id_list`, 没有 sub/unsub 区分. daemon 用此 internal proto_id 路由到
141/// `UnsubAccPushHandler` (调 `unsubscribe_trd_acc` 真撤订阅), 不发 backend.
142///
143/// **0x80000000 标记 bit**: 内部合成 ID, 不与真 backend cmd_id 冲突. 真
144/// backend 看到此 ID 会 reject (但不会到达 backend, daemon-local handler
145/// 直接处理). REST `/api/unsub-acc-push` routes to this daemon-local handler.
146pub const TRD_UNSUB_ACC_PUSH_INTERNAL: u32 = 0x8000_0000 | 2008;
147
148// 交易新版 API
149pub const TRD_GET_MARGIN_RATIO: u32 = 2223;
150pub const TRD_GET_ORDER_FEE: u32 = 2225;
151pub const TRD_FLOW_SUMMARY: u32 = 2226;
152
153// Cash log, cash detail, and business-group query endpoints.
154pub const TRD_GET_CASH_LOG: u32 = 22701; // mobile clt_cmd 3000
155pub const TRD_GET_CASH_DETAIL: u32 = 22702; // mobile clt_cmd 3001
156pub const TRD_GET_BIZ_GROUP: u32 = 22703; // mobile clt_cmd 3002
157
158// Backend NN command IDs for cash-log routing.
159pub const NN_CMD_GET_CASH_LOG: u16 = 3000;
160pub const NN_CMD_GET_CASH_DETAIL: u16 = 3001;
161pub const NN_CMD_GET_BIZ_GROUP: u16 = 3002;
162
163// Margin-account information per market.
164pub const TRD_GET_MARGIN_INFO: u32 = 22704;
165// Backend NN command IDs for per-market margin-info routing.
166pub const NN_CMD_HK_MARGIN_INFO: u16 = 3101;
167pub const NN_CMD_US_MARGIN_INFO: u16 = 3102;
168pub const NN_CMD_CN_AH_MARGIN_INFO: u16 = 3107;
169
170// Account compliance flags for product access, risk assessment, and opt-in status.
171pub const TRD_GET_ACCOUNT_FLAG: u32 = 22705; // FTAPI client→daemon
172pub const NN_CMD_PULL_ACCOUNT_FLAG: u16 = 5281; // backend NN cmd (NN_ProtoCmd_Pull_AccountFlag)
173
174// Bond holdings and bond trade-preparation endpoints.
175// Only HK / US / SG bond accounts normally return data; other accounts may return empty.
176pub const TRD_GET_BOND_TOTAL_ASSET: u32 = 22706; // 账户债券总持仓
177pub const TRD_GET_BOND_SINGLE_ASSET: u32 = 22707; // 单只债券持仓
178pub const TRD_GET_BOND_POSITION_LIST: u32 = 22708; // 账户债券持仓列表
179pub const TRD_GET_BOND_ANSWER_STATE: u32 = 22709; // 是否需要答题
180pub const TRD_GET_BOND_TRADE_REMINDER: u32 = 22710; // 交易提醒 (是否可买/复杂/高风险等)
181// daemon→backend NN cmd_id (mobile clt_cmd_* 同号)
182pub const NN_CMD_BOND_TOTAL_ASSET: u16 = 9373; // clt_cmd_cash_treasure_bond_total_asset
183pub const NN_CMD_BOND_SINGLE_ASSET: u16 = 9374; // clt_cmd_cash_treasure_bond_single_asset
184pub const NN_CMD_BOND_POSITION_LIST: u16 = 9375; // clt_cmd_cash_treasure_bond_account_position
185pub const NN_CMD_BOND_ANSWER_STATE: u16 = 10043; // clt_cmd_bond_answer_state
186pub const NN_CMD_BOND_TRADE_REMINDER: u16 = 10057; // clt_cmd_bond_trade_reminder
187
188pub const TRD_GET_FUNDS: u32 = 2101;
189pub const TRD_GET_POSITION_LIST: u32 = 2102;
190pub const TRD_GET_MAX_TRD_QTYS: u32 = 2111;
191pub const TRD_GET_COMBO_MAX_TRD_QTYS: u32 = 2112;
192pub const TRD_GET_ORDER_LIST: u32 = 2201;
193pub const TRD_PLACE_ORDER: u32 = 2202;
194pub const TRD_MODIFY_ORDER: u32 = 2205;
195pub const TRD_UPDATE_ORDER: u32 = 2208;
196pub const TRD_GET_ORDER_FILL_LIST: u32 = 2211;
197pub const TRD_UPDATE_ORDER_FILL: u32 = 2218;
198pub const TRD_GET_HISTORY_ORDER_LIST: u32 = 2221;
199pub const TRD_GET_HISTORY_ORDER_FILL_LIST: u32 = 2222;
200pub const TRD_PLACE_COMBO_ORDER: u32 = 2227;
201pub const TRD_RECONFIRM_ORDER: u32 = 2237;
202pub const TRD_NOTIFY: u32 = 2240;
203
204/// **Stable API** — 判断协议 ID 是否为推送类型。
205///
206/// 跨 futu-net / futu-server 共享判定，避免两处独立 match 漂移。
207#[must_use]
208pub fn is_push_proto(proto_id: u32) -> bool {
209    matches!(
210        proto_id,
211        NOTIFY
212            | QOT_UPDATE_BASIC_QOT
213            | QOT_UPDATE_KL
214            | QOT_UPDATE_RT
215            | QOT_UPDATE_TICKER
216            | QOT_UPDATE_ORDER_BOOK
217            | QOT_UPDATE_BROKER
218            | QOT_UPDATE_ORDER_DETAIL
219            | QOT_UPDATE_PRICE_REMINDER
220            | TRD_UPDATE_ORDER
221            | TRD_UPDATE_ORDER_FILL
222            | TRD_NOTIFY
223    )
224}
225
226#[cfg(test)]
227mod tests;
futu_core/proto_id.rs

futu_core/
proto_id.rs
