futu_core/

proto_id.rs

//! FutuOpenD API 协议 ID 常量
//!
//! 对应 C++ 中 `FTAPI_Define_ProtoID.h` 的定义。客户端与 OpenD 网关之间的
//! 通信协议标识。
//!
//! **Stable API** — 所有常量均为稳定 ABI，外部 binary 可依赖。新增常量不算
//! breaking；修改已有常量值 = breaking（C++ 对齐约束下不应发生）。

// ========== 连接管理 ==========
pub const INIT_CONNECT: u32 = 1001;
pub const GET_GLOBAL_STATE: u32 = 1002;
pub const NOTIFY: u32 = 1003;
pub const KEEP_ALIVE: u32 = 1004;

// ========== 额度查询 ==========
pub const GET_USED_QUOTA: u32 = 1010;

// ========== 行情协议 ==========
pub const QOT_SUB: u32 = 3001;
pub const QOT_REG_QOT_PUSH: u32 = 3002;
pub const QOT_GET_SUB_INFO: u32 = 3003;
pub const QOT_GET_BASIC_QOT: u32 = 3004;
pub const QOT_UPDATE_BASIC_QOT: u32 = 3005;
pub const QOT_GET_KL: u32 = 3006;
pub const QOT_UPDATE_KL: u32 = 3007;
pub const QOT_GET_RT: u32 = 3008;
pub const QOT_UPDATE_RT: u32 = 3009;
pub const QOT_GET_TICKER: u32 = 3010;
pub const QOT_UPDATE_TICKER: u32 = 3011;
pub const QOT_GET_ORDER_BOOK: u32 = 3012;
pub const QOT_UPDATE_ORDER_BOOK: u32 = 3013;
pub const QOT_GET_BROKER: u32 = 3014;
pub const QOT_UPDATE_BROKER: u32 = 3015;
pub const QOT_GET_ORDER_DETAIL: u32 = 3016;
pub const QOT_UPDATE_ORDER_DETAIL: u32 = 3017;

pub const QOT_GET_HISTORY_KL: u32 = 3100;
pub const QOT_GET_HISTORY_KL_POINTS: u32 = 3101;
pub const QOT_REQUEST_HISTORY_KL: u32 = 3103;

pub const QOT_GET_TRADE_DATE: u32 = 3200;
pub const QOT_GET_SUSPEND: u32 = 3201;
pub const QOT_GET_STATIC_INFO: u32 = 3202;
pub const QOT_GET_SECURITY_SNAPSHOT: u32 = 3203;
pub const QOT_GET_PLATE_SET: u32 = 3204;
pub const QOT_GET_PLATE_SECURITY: u32 = 3205;
pub const QOT_GET_REFERENCE: u32 = 3206;
pub const QOT_GET_OWNER_PLATE: u32 = 3207;
pub const QOT_GET_HOLDING_CHANGE_LIST: u32 = 3208;
pub const QOT_GET_OPTION_CHAIN: u32 = 3209;
pub const QOT_GET_REHAB: u32 = 3702;

// 新版 API
pub const QOT_GET_WARRANT: u32 = 3210;
pub const QOT_GET_CAPITAL_FLOW: u32 = 3211;
pub const QOT_GET_CAPITAL_DISTRIBUTION: u32 = 3212;
pub const QOT_GET_USER_SECURITY: u32 = 3213;
pub const QOT_MODIFY_USER_SECURITY: u32 = 3214;
pub const QOT_STOCK_FILTER: u32 = 3215;
pub const QOT_GET_CODE_CHANGE: u32 = 3216;
pub const QOT_GET_IPO_LIST: u32 = 3217;
pub const QOT_GET_FUTURE_INFO: u32 = 3218;
pub const QOT_REQUEST_TRADE_DATE: u32 = 3219;
pub const QOT_SET_PRICE_REMINDER: u32 = 3220;
pub const QOT_GET_PRICE_REMINDER: u32 = 3221;
pub const QOT_GET_USER_SECURITY_GROUP: u32 = 3222;
pub const QOT_GET_MARKET_STATE: u32 = 3223;
pub const QOT_GET_OPTION_EXPIRATION_DATE: u32 = 3224;
// Futu OpenAPI 10.6 QOT fundamental data / screen APIs.
pub const QOT_GET_FINANCIALS_EARNINGS_PRICE_MOVE: u32 = 3225;
pub const QOT_GET_FINANCIALS_EARNINGS_PRICE_HISTORY: u32 = 3226;
pub const QOT_GET_FINANCIALS_STATEMENTS: u32 = 3227;
pub const QOT_GET_FINANCIALS_REVENUE_BREAKDOWN: u32 = 3228;
pub const QOT_GET_RESEARCH_ANALYST_CONSENSUS: u32 = 3229;
pub const QOT_GET_RESEARCH_RATING_SUMMARY: u32 = 3230;
pub const QOT_GET_RESEARCH_MORNINGSTAR_REPORT: u32 = 3231;
pub const QOT_GET_VALUATION_DETAIL: u32 = 3232;
pub const QOT_GET_VALUATION_PLATE_STOCK_LIST: u32 = 3233;
pub const QOT_GET_CORPORATE_ACTIONS_DIVIDENDS: u32 = 3234;
pub const QOT_GET_CORPORATE_ACTIONS_BUYBACKS: u32 = 3235;
pub const QOT_GET_CORPORATE_ACTIONS_STOCK_SPLITS: u32 = 3236;
pub const QOT_GET_SHAREHOLDERS_OVERVIEW: u32 = 3237;
pub const QOT_GET_SHAREHOLDERS_HOLDING_CHANGES: u32 = 3238;
pub const QOT_GET_SHAREHOLDERS_HOLDER_DETAIL: u32 = 3239;
pub const QOT_GET_SHAREHOLDERS_INSTITUTIONAL: u32 = 3240;
pub const QOT_GET_INSIDER_HOLDER_LIST: u32 = 3241;
pub const QOT_GET_INSIDER_TRADE_LIST: u32 = 3242;
pub const QOT_GET_COMPANY_PROFILE: u32 = 3243;
pub const QOT_GET_COMPANY_EXECUTIVES: u32 = 3244;
pub const QOT_GET_COMPANY_EXECUTIVE_BACKGROUND: u32 = 3245;
pub const QOT_GET_COMPANY_OPERATIONAL_EFFICIENCY: u32 = 3246;
pub const QOT_GET_TOP_TEN_BUY_SELL_BROKERS: u32 = 3247;
pub const QOT_GET_DAILY_SHORT_VOLUME: u32 = 3248;
pub const QOT_GET_SHORT_INTEREST: u32 = 3249;
pub const QOT_GET_OPTION_VOLATILITY: u32 = 3250;
pub const QOT_GET_OPTION_EXERCISE_PROBABILITY: u32 = 3251;
pub const QOT_STOCK_SCREEN: u32 = 3252;
pub const QOT_OPTION_SCREEN: u32 = 3253;
pub const QOT_WARRANT_SCREEN: u32 = 3254;
pub const QOT_GET_OPTION_QUOTE: u32 = 3255;
pub const QOT_GET_OPTION_STRATEGY: u32 = 3256;
pub const QOT_GET_OPTION_STRATEGY_ANALYSIS: u32 = 3257;
pub const QOT_GET_OPTION_STRATEGY_SPREAD: u32 = 3258;
// Futu OpenAPI 10.7+ QOT calendar, macro, rank, and hot-list APIs.
// Ref: C++ feature/2606 `APIServerCS_Define_ProtoID.h` lists public QOT
// 3401-3433. Rust stages them incrementally, with each shipped subset wired
// through EndpointSpec/REST/MCP/CLI guards before release.
pub const QOT_GET_EARNINGS_CALENDAR: u32 = 3401;
pub const QOT_GET_MACRO_INDICATOR_LIST: u32 = 3402;
pub const QOT_GET_MACRO_INDICATOR_HISTORY: u32 = 3403;
pub const QOT_GET_FED_WATCH_TARGET_RATE: u32 = 3404;
pub const QOT_GET_FED_WATCH_DOT_PLOT: u32 = 3405;
pub const QOT_GET_EARNINGS_BEAT_RANK: u32 = 3406;
pub const QOT_GET_DIVIDEND_RANK: u32 = 3407;
pub const QOT_GET_DIVIDEND_CALENDAR: u32 = 3408;
pub const QOT_GET_ECONOMIC_CALENDAR: u32 = 3409;
pub const QOT_GET_US_PRE_MARKET_RANK: u32 = 3410;
pub const QOT_GET_US_AFTER_HOURS_RANK: u32 = 3411;
pub const QOT_GET_US_OVERNIGHT_RANK: u32 = 3412;
pub const QOT_GET_TOP_MOVERS_RANK: u32 = 3413;
pub const QOT_GET_HOT_LIST: u32 = 3414;
pub const QOT_GET_SHORT_SELLING_RANK: u32 = 3415;
pub const QOT_GET_PERIOD_CHANGE_RANK: u32 = 3416;
pub const QOT_GET_HIGH_DIVIDEND_SOE_RANK: u32 = 3417;
pub const QOT_GET_INSTITUTION_LIST: u32 = 3418;
pub const QOT_GET_INSTITUTION_PROFILE: u32 = 3419;
pub const QOT_GET_INSTITUTION_DISTRIBUTION: u32 = 3420;
pub const QOT_GET_INSTITUTION_HOLDING_CHANGE: u32 = 3421;
pub const QOT_GET_INSTITUTION_HOLDING_LIST: u32 = 3422;
pub const QOT_GET_ARK_FUND_HOLDING: u32 = 3423;
pub const QOT_GET_ARK_STOCK_DYNAMIC: u32 = 3424;
pub const QOT_GET_ARK_ACTIVE_TRANSACTION: u32 = 3425;
pub const QOT_GET_RATING_CHANGE: u32 = 3426;
pub const QOT_GET_INDUSTRIAL_CHAIN_LIST: u32 = 3427;
pub const QOT_GET_INDUSTRIAL_CHAIN_DETAIL: u32 = 3428;
pub const QOT_GET_INDUSTRIAL_CHAIN_BY_PLATE: u32 = 3429;
pub const QOT_GET_INDUSTRIAL_PLATE_INFO: u32 = 3430;
pub const QOT_GET_INDUSTRIAL_PLATE_STOCK: u32 = 3431;
pub const QOT_GET_HEAT_MAP_DATA: u32 = 3432;
pub const QOT_GET_RISE_FALL_DISTRIBUTION: u32 = 3433;
pub const QOT_GET_TECHNICAL_UNUSUAL: u32 = 3801;
pub const QOT_GET_FINANCIAL_UNUSUAL: u32 = 3802;
pub const QOT_GET_DERIVATIVE_UNUSUAL: u32 = 3803;
pub const QOT_UPDATE_PRICE_REMINDER: u32 = 3019;
pub const QOT_REQUEST_HISTORY_KL_QUOTA: u32 = 3104;
pub const QOT_REQUEST_REHAB: u32 = 3105;

// 其他
pub const VERIFICATION: u32 = 1006;
pub const GET_USER_INFO: u32 = 1005;
pub const GET_DELAY_STATISTICS: u32 = 1007;
pub const TEST_CMD: u32 = 1008;
pub const REMOTE_CMD: u32 = 1009;

// NN/MM token enablement and binding-state query, useful for unlock-trade diagnostics.
pub const GET_TOKEN_STATE: u32 = 1326;

// Risk-free-rate query for option pricing; returns HK / US / JP rates.
pub const QOT_GET_RISK_FREE_RATE: u32 = 20231;

// Mobile/moomoo financial calendar view query; internal/extension backend
// command used by legacy Rust-only financial-calendar surfaces. Public
// OpenAPI earnings calendar is QOT_GET_EARNINGS_CALENDAR (3401).
pub const QOT_GET_FINANCIAL_CALENDAR_VIEW_INTERNAL: u32 = 20025;
// Mobile/moomoo target-stock financial calendar search.
// Rust OpenD read-only extension; backend/platform CMD20426.
pub const QOT_SEARCH_TARGET_FINANCIAL_CALENDAR: u32 = 20426;

// Spread-table query for quote price increments.
pub const QOT_GET_SPREAD_TABLE: u32 = 6503;

// Ticker-statistic summary query.
pub const QOT_GET_TICKER_STATISTIC: u32 = 6365;
// Ticker-statistic detail query; returns statistic rows plus pagination metadata.
pub const QOT_GET_TICKER_STATISTIC_DETAIL: u32 = 6366;

// ========== 交易协议 ==========
pub const TRD_GET_ACC_LIST: u32 = 2001;
pub const TRD_UNLOCK_TRADE: u32 = 2005;
pub const TRD_SUB_ACC_PUSH: u32 = 2008;

/// Rust-daemon local public proto_id for CLI/raw TCP account-push unsubscribe.
///
/// C++/backend only defines `TRD_SUB_ACC_PUSH` (2008) with `acc_id_list`; it has
/// no sub/unsub discriminator. Rust therefore needs a daemon-local routing id
/// for account-push unsubscribe. This low-bit id is intentionally public-reachable
/// for `futucli unsub-acc-push`; it must not be forwarded to backend.
pub const TRD_UNSUB_ACC_PUSH_LOCAL: u32 = 0x7FFF_0000 | TRD_SUB_ACC_PUSH;

/// Daemon-internal proto_id for `/api/unsub-acc-push`.
///
/// **不是真 backend cmd_id** — backend `Trd_SubAccPush` proto 只有
/// `acc_id_list`, 没有 sub/unsub 区分. daemon 用此 internal proto_id 路由到
/// `UnsubAccPushHandler` (调 `unsubscribe_trd_acc` 真撤订阅), 不发 backend.
///
/// **0x80000000 标记 bit**: 内部合成 ID, 不与真 backend cmd_id 冲突. 真
/// backend 看到此 ID 会 reject (但不会到达 backend, daemon-local handler
/// 直接处理). REST `/api/unsub-acc-push` routes to this daemon-local handler.
pub const TRD_UNSUB_ACC_PUSH_INTERNAL: u32 = 0x8000_0000 | 2008;

// 交易新版 API
pub const TRD_GET_MARGIN_RATIO: u32 = 2223;
pub const TRD_GET_ORDER_FEE: u32 = 2225;
pub const TRD_FLOW_SUMMARY: u32 = 2226;

// Cash log, cash detail, and business-group query endpoints.
pub const TRD_GET_CASH_LOG: u32 = 22701; // mobile clt_cmd 3000
pub const TRD_GET_CASH_DETAIL: u32 = 22702; // mobile clt_cmd 3001
pub const TRD_GET_BIZ_GROUP: u32 = 22703; // mobile clt_cmd 3002

// Backend NN command IDs for cash-log routing.
pub const NN_CMD_GET_CASH_LOG: u16 = 3000;
pub const NN_CMD_GET_CASH_DETAIL: u16 = 3001;
pub const NN_CMD_GET_BIZ_GROUP: u16 = 3002;

// Margin-account information per market.
pub const TRD_GET_MARGIN_INFO: u32 = 22704;
// Backend NN command IDs for per-market margin-info routing.
pub const NN_CMD_HK_MARGIN_INFO: u16 = 3101;
pub const NN_CMD_US_MARGIN_INFO: u16 = 3102;
pub const NN_CMD_CN_AH_MARGIN_INFO: u16 = 3107;

// Account compliance flags for product access, risk assessment, and opt-in status.
pub const TRD_GET_ACCOUNT_FLAG: u32 = 22705; // FTAPI client→daemon
pub const NN_CMD_PULL_ACCOUNT_FLAG: u16 = 5281; // backend NN cmd (NN_ProtoCmd_Pull_AccountFlag)

// Bond holdings and bond trade-preparation endpoints.
// Only HK / US / SG bond accounts normally return data; other accounts may return empty.
pub const TRD_GET_BOND_TOTAL_ASSET: u32 = 22706; // 账户债券总持仓
pub const TRD_GET_BOND_SINGLE_ASSET: u32 = 22707; // 单只债券持仓
pub const TRD_GET_BOND_POSITION_LIST: u32 = 22708; // 账户债券持仓列表
pub const TRD_GET_BOND_ANSWER_STATE: u32 = 22709; // 是否需要答题
pub const TRD_GET_BOND_TRADE_REMINDER: u32 = 22710; // 交易提醒 (是否可买/复杂/高风险等)
// daemon→backend NN cmd_id (mobile clt_cmd_* 同号)
pub const NN_CMD_BOND_TOTAL_ASSET: u16 = 9373; // clt_cmd_cash_treasure_bond_total_asset
pub const NN_CMD_BOND_SINGLE_ASSET: u16 = 9374; // clt_cmd_cash_treasure_bond_single_asset
pub const NN_CMD_BOND_POSITION_LIST: u16 = 9375; // clt_cmd_cash_treasure_bond_account_position
pub const NN_CMD_BOND_ANSWER_STATE: u16 = 10043; // clt_cmd_bond_answer_state
pub const NN_CMD_BOND_TRADE_REMINDER: u16 = 10057; // clt_cmd_bond_trade_reminder

pub const TRD_GET_FUNDS: u32 = 2101;
pub const TRD_GET_POSITION_LIST: u32 = 2102;
pub const TRD_GET_MAX_TRD_QTYS: u32 = 2111;
pub const TRD_GET_COMBO_MAX_TRD_QTYS: u32 = 2112;
pub const TRD_GET_ORDER_LIST: u32 = 2201;
pub const TRD_PLACE_ORDER: u32 = 2202;
pub const TRD_MODIFY_ORDER: u32 = 2205;
pub const TRD_UPDATE_ORDER: u32 = 2208;
pub const TRD_GET_ORDER_FILL_LIST: u32 = 2211;
pub const TRD_UPDATE_ORDER_FILL: u32 = 2218;
pub const TRD_GET_HISTORY_ORDER_LIST: u32 = 2221;
pub const TRD_GET_HISTORY_ORDER_FILL_LIST: u32 = 2222;
pub const TRD_PLACE_COMBO_ORDER: u32 = 2227;
pub const TRD_RECONFIRM_ORDER: u32 = 2237;
pub const TRD_NOTIFY: u32 = 2240;

/// **Stable API** — 判断协议 ID 是否为推送类型。
///
/// 跨 futu-net / futu-server 共享判定，避免两处独立 match 漂移。
#[must_use]
pub fn is_push_proto(proto_id: u32) -> bool {
    matches!(
        proto_id,
        NOTIFY
            | QOT_UPDATE_BASIC_QOT
            | QOT_UPDATE_KL
            | QOT_UPDATE_RT
            | QOT_UPDATE_TICKER
            | QOT_UPDATE_ORDER_BOOK
            | QOT_UPDATE_BROKER
            | QOT_UPDATE_ORDER_DETAIL
            | QOT_UPDATE_PRICE_REMINDER
            | TRD_UPDATE_ORDER
            | TRD_UPDATE_ORDER_FILL
            | TRD_NOTIFY
    )
}

#[cfg(test)]
mod tests;