跳转至

REST API 完整参考

v1.4.85 新增. 本文件由 FutuOpenD-rs 自动生成工具产出, 跟随 daemon 每个 release 版本更新.

本页涵盖 futu-opend REST API 全部 85 个 endpoint, 按功能 分 9 组. 每 endpoint 给出:

  • HTTP 方法 + URL
  • Backend proto_id
  • 需要的 scope (auth)
  • 参数说明 (见 proto 定义)
  • 错误提示
  • curl 示例

快速导航:

Endpoint 数 链接
系统 / 状态 6 系统 / 状态
行情订阅 5 行情订阅
行情查询 18 行情查询
板块 / 筛选 / 元数据 8 板块 / 筛选 / 元数据
参考资料 / 衍生品 11 参考资料 / 衍生品
到价提醒 2 到价提醒
交易账户 26 交易账户
交易写入 6 交易写入
管理 (admin) 3 管理 (admin)

全局约定

  • Base URL: http://127.0.0.1:22499 (默认 REST 端口, 可通过 --rest-port 改)
  • Content-Type: application/json
  • Auth: Authorization: Bearer <API_KEY> (若配了 keys.json; 否则 legacy 模式无 auth — 且 v1.4.86 起为生产 fail-closed 默认)
  • 响应结构:

    {
      "ret_type": 0,
      "ret_msg": null,
      "err_code": null,
      "s2c": { ...业务数据... }
    }
    
    ret_type == 0 为成功, 其他值参见 常用错误码.

  • 字段命名: v1.4.83+ 支持 alias (SDK 风格 code / stocks / trd_env 等), canonical 是 snake_case (symbol / symbols / env). REST 层 enum 字段 (e.g. trd_market / trd_env / kl_type / op / reference_type) 只接 int (½/3...); 字符串 ("HK"/"US"/"day") 仅 MCP 层 (futu_* tool) 接受 + 自动转 int. 未知字段 v1.4.84 起 loud fail (unknown field error).

  • 限额: 启动参数 --allowed-markets / --max-order-value 等控制. 详见 docs/guide/auth.md.


系统 / 状态

健康检查、全局状态、用户信息、延迟统计。无需 auth。

GET /api/delay-statistics

proto_id: GET_DELAY_STATISTICS (1006)

Scope: — (public)

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/api/delay-statistics

POST /api/delay-statistics

proto_id: GET_DELAY_STATISTICS (1006)

Scope: — (public)

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"type_list":[1],"qot_push_stage":1}' \
  http://127.0.0.1:22499/api/delay-statistics

GET /api/global-state

proto_id: GET_GLOBAL_STATE (1002)

Scope: — (public)

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/api/global-state

GET /api/ping

proto_id: GET_GLOBAL_STATE (1002)

Scope: — (public)

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/api/ping

GET /api/push-subscriber-info

proto_id: — (non-proto / 无 backend 转发)

Scope: — (public)

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/api/push-subscriber-info

GET /api/user-info

proto_id: GET_USER_INFO (1005)

Scope: — (public)

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/api/user-info

行情订阅

订阅 / 取消订阅行情推送,查询订阅状态。WebSocket /ws 接收推送。/api/subscribe/api/unsubscribe v1.4.110+ 归 qot:state (用户态写接口);过渡期持 qot:read 兼容。

POST /api/query-subscription

proto_id: QOT_GET_SUB_INFO (3003)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"is_req_all_conn":true}' \
  http://127.0.0.1:22499/api/query-subscription

POST /api/used-quota

proto_id: GET_USED_QUOTA (1010)

Scope: qot:read

参数 / 返回: 空请求体或 {}。返回当前 daemon 已用订阅额度 used_sub_quota 和历史 K 线额度 used_k_line_quota

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{}' \
  http://127.0.0.1:22499/api/used-quota

GET /api/sub-info

proto_id: QOT_GET_SUB_INFO (3003)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/api/sub-info

POST /api/subscribe

proto_id: QOT_SUB (3001)

Scope: qot:state

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbols":["HK.00700"],"sub_types":[1],"is_sub_or_un_sub":true}' \
  http://127.0.0.1:22499/api/subscribe

POST /api/unsubscribe

proto_id: QOT_SUB (3001)

Scope: qot:state

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbols":["HK.00700"],"sub_types":[1],"is_sub_or_un_sub":false}' \
  http://127.0.0.1:22499/api/unsubscribe

GET /ws

proto_id: — (non-proto / 无 backend 转发)

Scope: — (public)

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/ws

行情查询

实时行情、K 线、摆盘、经纪队列、分时、成交明细、逐笔统计、无风险利率、摆盘步长。需 qot:read

POST /api/broker

proto_id: QOT_GET_BROKER (3014)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700"}' \
  http://127.0.0.1:22499/api/broker

POST /api/capital-distribution

proto_id: QOT_GET_CAPITAL_DISTRIBUTION (3212)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700"}' \
  http://127.0.0.1:22499/api/capital-distribution

POST /api/capital-flow

proto_id: QOT_GET_CAPITAL_FLOW (3211)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700","period_type":1}' \
  http://127.0.0.1:22499/api/capital-flow

POST /api/history-kl-quota

proto_id: QOT_REQUEST_HISTORY_KL_QUOTA (3104)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1},"begin_time":"2026-01-01 00:00:00","end_time":"2026-04-01 23:59:59"}}' \
  http://127.0.0.1:22499/api/history-kl-quota

POST /api/history-kline

proto_id: QOT_REQUEST_HISTORY_KL (3103)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

注意: REST kl_type 仅接 int (e.g. 1=Day / 2=Week / 3=Month / 5=Min1 / 6=Min5 / 7=Min15 / 8=Min30 / 9=Min60 / 10=Min3 / 11=Min4); 字符串 "day" 仅 MCP 层支持. 字段 count 已 alias 到 proto req_num (可双接).

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700","rehab_type":0,"kl_type":1,"max_count":100,"begin_time":"2026-01-01 00:00:00","end_time":"2026-04-01 23:59:59"}' \
  http://127.0.0.1:22499/api/history-kline

POST /api/kline

proto_id: QOT_GET_KL (3006)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

注意: 同 /api/history-kline — REST kl_type 仅接 int; proto 字段名是 req_num (canonical), count 是 v1.4.83+ alias.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700","rehab_type":0,"kl_type":1,"req_num":100}' \
  http://127.0.0.1:22499/api/kline

POST /api/market-state

proto_id: QOT_GET_MARKET_STATE (3223)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbols":["HK.00700"]}' \
  http://127.0.0.1:22499/api/market-state

POST /api/orderbook

proto_id: QOT_GET_ORDER_BOOK (3012)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700","depth":10}' \
  http://127.0.0.1:22499/api/orderbook

POST /api/quote

proto_id: QOT_GET_BASIC_QOT (3004)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700"}' \
  http://127.0.0.1:22499/api/quote

GET /api/risk-free-rate

proto_id: QOT_GET_RISK_FREE_RATE (20231)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

用途: 期权 Black-Scholes 定价必备数据 (HK / US / JP 三市场无风险利率).

字段表 (无必填字段):

字段 类型 必填 说明
rate_time int64 optional Unix ms 时间戳; 不传 = 最新利率

返回: s2chk_rate_pct / us_rate_pct / jp_rate_pct (百分比, e.g. 4.5 即 4.5%); 同时透出 raw uint64 (× 10^9) 供调用方自行 verify.

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/api/risk-free-rate

POST /api/risk-free-rate

proto_id: QOT_GET_RISK_FREE_RATE (20231)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

用途: 期权 Black-Scholes 定价必备数据 (HK / US / JP 三市场无风险利率).

字段表 (无必填字段):

字段 类型 必填 说明
rate_time int64 optional Unix ms 时间戳; 不传 = 最新利率

返回: s2chk_rate_pct / us_rate_pct / jp_rate_pct (百分比, e.g. 4.5 即 4.5%); 同时透出 raw uint64 (× 10^9) 供调用方自行 verify.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{}' \
  http://127.0.0.1:22499/api/risk-free-rate

POST /api/rt

proto_id: QOT_GET_RT (3008)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700"}' \
  http://127.0.0.1:22499/api/rt

POST /api/snapshot

proto_id: QOT_GET_SECURITY_SNAPSHOT (3203)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700"}' \
  http://127.0.0.1:22499/api/snapshot

GET /api/spread-table

proto_id: QOT_GET_SPREAD_TABLE (6503)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

用途: 价位表用于查询不同价格区间的最小变动单位 (e.g. HK 股票 0.01~0.25 → 步长 0.001 等). 客户端做 PlaceOrder / ModifyOrder 时校验价格合法性必备.

字段表 (无业务参数):

字段 类型 必填 说明
reserved int optional 占位字段, 可不传; 总返全部价位表

返回: s2c.spread_table_list 含每张价位表 (spread_code + spread_item_list), 每条 item 含 price_from / price_to / value (f64, 已 / 1e9 还原成实际价格).

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/api/spread-table

POST /api/spread-table

proto_id: QOT_GET_SPREAD_TABLE (6503)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

用途: 价位表用于查询不同价格区间的最小变动单位 (e.g. HK 股票 0.01~0.25 → 步长 0.001 等). 客户端做 PlaceOrder / ModifyOrder 时校验价格合法性必备.

字段表 (无业务参数):

字段 类型 必填 说明
reserved int optional 占位字段, 可不传; 总返全部价位表

返回: s2c.spread_table_list 含每张价位表 (spread_code + spread_item_list), 每条 item 含 price_from / price_to / value (f64, 已 / 1e9 还原成实际价格).

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{}' \
  http://127.0.0.1:22499/api/spread-table

POST /api/static-info

proto_id: QOT_GET_STATIC_INFO (3202)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbols":["HK.00700","US.AAPL"]}' \
  http://127.0.0.1:22499/api/static-info

POST /api/ticker

proto_id: QOT_GET_TICKER (3010)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700","count":50}' \
  http://127.0.0.1:22499/api/ticker

POST /api/ticker-statistic

proto_id: QOT_GET_TICKER_STATISTIC (6365)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

用途: 逐笔统计. 按时间间隔聚合分笔成交 (累计成交量 / 成交额 / 平均价).

字段表:

字段 类型 必填 说明
securitysymbol object/string 标的; shorthand "HK.00700"
interval_type int 聚合粒度 enum (具体值见 proto)

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700","interval_type":1}' \
  http://127.0.0.1:22499/api/ticker-statistic

板块 / 筛选 / 元数据

板块列表、板块成分、股票筛选、交易日、停牌、代码变更、IPO 日历。

POST /api/code-change

proto_id: QOT_GET_CODE_CHANGE (3216)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"search":{"code_change_type_list":[1],"time_filter_list":[{"type":1,"begin_time":"2026-01-01","end_time":"2026-04-01"}]}}' \
  http://127.0.0.1:22499/api/code-change

POST /api/ipo-list

proto_id: QOT_GET_IPO_LIST (3217)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

字段表:

字段 类型 必填 说明
market int QotMarket: 1=HK / 11=US / 21=CN_SH / 22=CN_SZ (沪深合并返 A 股)

注意: backend 区分 HK / US / A 股 (沪深合并). 传错 market 会返 无效市场.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"market":1}}' \
  http://127.0.0.1:22499/api/ipo-list

POST /api/list-plates

proto_id: QOT_GET_PLATE_SET (3204)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"market":1,"plate_set_type":0}' \
  http://127.0.0.1:22499/api/list-plates

POST /api/plate-security

proto_id: QOT_GET_PLATE_SECURITY (3205)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"plate":{"market":1,"code":"BK1001"}}' \
  http://127.0.0.1:22499/api/plate-security

POST /api/plate-set

proto_id: QOT_GET_PLATE_SET (3204)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"market":1,"plate_set_type":0}' \
  http://127.0.0.1:22499/api/plate-set

POST /api/stock-filter

proto_id: QOT_STOCK_FILTER (3215)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"begin":0,"num":50,"market":1,"plate":{"market":1,"code":"BK1001"}}' \
  http://127.0.0.1:22499/api/stock-filter

POST /api/suspend

proto_id: QOT_GET_SUSPEND (3201)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbols":["HK.00700"],"begin_time":"2026-01-01","end_time":"2026-04-01"}' \
  http://127.0.0.1:22499/api/suspend

POST /api/trading-days

proto_id: QOT_REQUEST_TRADE_DATE (3219)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"market":1,"begin_time":"2026-01-01","end_time":"2026-04-01"}' \
  http://127.0.0.1:22499/api/trading-days

参考资料 / 衍生品

正股关联窝轮、期权链、期权到期日、期货合约信息、复权、自选股、持股变动。/api/modify-user-security v1.4.110+ 归 qot:state (修改自选股是用户态写接口);持 qot:read 过渡兼容。

POST /api/future-info

proto_id: QOT_GET_FUTURE_INFO (3218)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

字段表:

字段 类型 必填 说明
security_listsymbols array 期货合约; 例 ["HK.HSImain", "US.NQmain"]

注意: 空 security_list 在 backend 返 没有指定股票 错误, 必须至少 1 个合约.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"securityList":[{"market":1,"code":"HSImain"}]}}' \
  http://127.0.0.1:22499/api/future-info

POST /api/get-reference

proto_id: QOT_GET_REFERENCE (3206)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

字段表:

字段 类型 必填 说明
securitysymbol object/string 标的股票; shorthand "HK.00700"
reference_type int 1=Warrant 窝轮 / 2=Future 期货主连相关合约

Option 不支持: backend ReferenceType proto 只定义 Warrant / Future. 传 "reference_type":3 会返 unsupported reference type. MCP futu_get_reference 工具同样收紧, 仅接 warrant / future.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700","reference_type":1}' \
  http://127.0.0.1:22499/api/get-reference

POST /api/holding-change

proto_id: QOT_GET_HOLDING_CHANGE_LIST (3208)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

⚠️ 已废弃 (Deprecated): 上游 backend 已停止维护此接口 (2020-12-21 起). 调用会返 ret_type=-1 + "will be abandoned after 2020-12-21". 不再保证可用, 不应在新代码中使用.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700","holder_category":1,"begin_time":"2026-01-01","end_time":"2026-04-01"}' \
  http://127.0.0.1:22499/api/holding-change

POST /api/modify-user-security

proto_id: QOT_MODIFY_USER_SECURITY (3214)

Scope: qot:state

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

有副作用 (stateful write): 改用户自选股. 误传字段会被 v1.4.84+ loud-fail 拒, 但成功调用后无回滚.

字段表 (REST 仅接 int enum):

字段 类型 必填 说明
group_name string 自选分组名; 同名取首个
op int 1=Add 新增 / 2=Del 删除 / 3=MoveOut 移出分组
security_list array 股票数组; 每项 {market: int, code: string}

Shorthand 不支持: 顶层 symbol / symbols 不接, 必须显式 security_list.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"group_name":"自选","op":1,"security_list":[{"market":1,"code":"00700"}]}' \
  http://127.0.0.1:22499/api/modify-user-security

POST /api/option-chain

proto_id: QOT_GET_OPTION_CHAIN (3209)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

字段表:

字段 类型 必填 说明
ownersymbol object/string 期权标的股 (港美正股、恒指/国指/美指); shorthand "HK.00700"
begin_time string 行权日开始 (YYYY-MM-DD)
end_time string 行权日结束 (YYYY-MM-DD)
condition object optional 期权过滤条件 (类型 / 行权价范围 / 行情数据)

Owner shorthand: 仅支持顶层 "owner":"HK.00700" 自动展开为 Security 对象; 支持 "security":{...} 显式 (proto 字段是 owner 不是 security).

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"owner":"HK.00700","begin_time":"2026-05-01","end_time":"2026-06-01"}' \
  http://127.0.0.1:22499/api/option-chain

POST /api/option-expiration-date

proto_id: QOT_GET_OPTION_EXPIRATION_DATE (3224)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

字段表:

字段 类型 必填 说明
ownersymbol object/string 期权标的股; shorthand "HK.00700"
index_option_type int optional 仅恒指 / 国指: IndexOptionType

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"owner":"HK.00700"}' \
  http://127.0.0.1:22499/api/option-expiration-date

POST /api/owner-plate

proto_id: QOT_GET_OWNER_PLATE (3207)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

字段表:

字段 类型 必填 说明
security_listsymbols array 股票数组; shorthand ["HK.00700"] 自动展开

注意: 空 security_list 返空板块列表, 无业务意义; 至少给 1 个 stock.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbols":["HK.00700"]}' \
  http://127.0.0.1:22499/api/owner-plate

POST /api/reference

proto_id: QOT_GET_REFERENCE (3206)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

: /api/reference/api/get-reference 等价 (同 proto_id 3206); /api/get-reference 是 v1.4.74 加的 alias. 字段契约相同 — 见 /api/get-reference 段.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700","reference_type":1}' \
  http://127.0.0.1:22499/api/reference

POST /api/rehab

proto_id: QOT_REQUEST_REHAB (3105)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbols":["HK.00700"]}' \
  http://127.0.0.1:22499/api/rehab

POST /api/user-security

proto_id: QOT_GET_USER_SECURITY (3213)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"group_name":"自选"}' \
  http://127.0.0.1:22499/api/user-security

POST /api/warrant

proto_id: QOT_GET_WARRANT (3210)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

字段表 (核心):

字段 类型 必填 说明
begin int 起始行号 (分页)
num int 拉取数量 (≤200)
sort_field int WarrantField 排序字段 enum
ascend bool 是否升序
ownersymbol object/string optional 正股; shorthand "HK.00700"

完整字段: 包括 type_list / issuer_list / strike-price 等多组 filter 条件; 见 proto 定义.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"begin":0,"num":50,"sort_field":1,"ascend":false,"owner":"HK.00700"}' \
  http://127.0.0.1:22499/api/warrant

到价提醒

查询 / 设置 / 修改 / 删除到价提醒。/api/set-price-reminder v1.4.110+ 归 qot:state/api/price-reminder (查询) 仍是 qot:read

POST /api/price-reminder

proto_id: QOT_GET_PRICE_REMINDER (3221)

Scope: qot:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700"}' \
  http://127.0.0.1:22499/api/price-reminder

POST /api/set-price-reminder

proto_id: QOT_SET_PRICE_REMINDER (3220)

Scope: qot:state

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

有副作用 (stateful write): 设置 / 修改 / 删除到价提醒.

字段表 (REST 仅接 int enum; proto 字段名是 type 不是 reminder_type):

字段 类型 必填 说明
securitysymbol object/string 股票; shorthand "HK.00700"
op int 1=Add / 2=Del / 3=Enable / 4=Disable / 5=Modify / 6=DelAll
key int64 修改/删除时 GetPriceReminder 拿到的提醒 key
type int Add PriceReminderType (1=PriceUp / 2=PriceDown / ...)
freq int Add PriceReminderFreq (1=Always / 2=OnceADay / 3=OnlyOnce); Modify 时 backend 保留旧值时可省
value f64 Add 提醒值 (精确到小数点后 3 位); Modify 时 backend 保留旧值时可省
note string optional 标注 (≤20 中文字符)

Add (op=1) 必填字段: type + freq + value. gateway 对齐 C++ 在 Add 路径强制三者非空.

Modify (op=5) 不强制 type / freq / value: gateway 先拉旧项, 用户提供字段覆盖, 未提供则保留旧值 (对齐 C++ 覆盖式 Modify 语义).

reminder_session_list (optional, 数组): PriceReminderMarketStatus 枚举值: 1=Open / 2=USPre / 3=USAfter / 4=USOverNight. 任何非 1..4 的值会被 gateway loud reject (-1 + 错误文案). 美股留空时 daemon 默认补 [1, 2, 3]; 非美股自动清空.

注意: REST 不接 "op":"SetAdd" 字符串形态; 仅 MCP 层支持 op string→int.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"symbol":"HK.00700","op":1,"type":1,"freq":1,"value":300.0}' \
  http://127.0.0.1:22499/api/set-price-reminder

交易账户

账户列表、资金、持仓、今日订单、今日成交、历史订单 / 成交、最大可下单数、保证金比率、手续费。需 acc:read

POST /api/acc-cash-flow

proto_id: TRD_FLOW_SUMMARY (2226)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1},"clearing_date":"2026-04-01"}}' \
  http://127.0.0.1:22499/api/acc-cash-flow

POST /api/account-flag

proto_id: TRD_GET_ACCOUNT_FLAG (22705)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1}}}' \
  http://127.0.0.1:22499/api/account-flag

GET /api/accounts

proto_id: TRD_GET_ACC_LIST (2001)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/api/accounts

POST /api/biz-group

proto_id: TRD_GET_BIZ_GROUP (22703)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1}}}' \
  http://127.0.0.1:22499/api/biz-group

POST /api/bond-answer-state

proto_id: TRD_GET_BOND_ANSWER_STATE (22709)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1}}}' \
  http://127.0.0.1:22499/api/bond-answer-state

POST /api/bond-position-list

proto_id: TRD_GET_BOND_POSITION_LIST (22708)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1}}}' \
  http://127.0.0.1:22499/api/bond-position-list

POST /api/bond-single-asset

proto_id: TRD_GET_BOND_SINGLE_ASSET (22707)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1}}}' \
  http://127.0.0.1:22499/api/bond-single-asset

POST /api/bond-total-asset

proto_id: TRD_GET_BOND_TOTAL_ASSET (22706)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1}}}' \
  http://127.0.0.1:22499/api/bond-total-asset

POST /api/bond-trade-reminder

proto_id: TRD_GET_BOND_TRADE_REMINDER (22710)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1}}}' \
  http://127.0.0.1:22499/api/bond-trade-reminder

POST /api/cash-detail

proto_id: TRD_GET_CASH_DETAIL (22702)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1},"flow_id":"<flow_id>"}}' \
  http://127.0.0.1:22499/api/cash-detail

POST /api/cash-log

proto_id: TRD_GET_CASH_LOG (22701)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1},"begin_time":"2026-01-01","end_time":"2026-04-01"}}' \
  http://127.0.0.1:22499/api/cash-log

POST /api/flow-summary

proto_id: TRD_FLOW_SUMMARY (2226)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1},"clearing_date":"2026-04-01"}}' \
  http://127.0.0.1:22499/api/flow-summary

POST /api/funds

proto_id: TRD_GET_FUNDS (2101)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

currency 参数(整数枚举,对齐 proto/Trd_Common.proto::Currency):

整数 币种 整数 币种
1 HKD 5 SGD
2 USD 6 AUD
3 CNH 7 CAD
4 JPY 8 MYR
  • 综合账户 / 期货账户currency 必填。不传时返 MissingCurrency 错误并列出账号实际支持的币种集合(v1.4.106 起的行为)。
  • 单市场账户 / 模拟账户currency 可选;不传时按账户原生币种返回。
  • 仅接受整数。传字符串(如 "HKD")会报 invalid type: string, expected i32
  • 账号实际支持的币种集合由后端返回;不支持的币种返 InvalidCurrency 并列出可用值(v1.4.105 起)。

示例(综合账户,USD 计价):

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1},"currency":2}}' \
  http://127.0.0.1:22499/api/funds

示例(单市场账户,不传 currency):

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1}}}' \
  http://127.0.0.1:22499/api/funds

POST /api/history-order-fills

proto_id: TRD_GET_HISTORY_ORDER_FILL_LIST (2222)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1},"begin_time":"2026-01-01 00:00:00","end_time":"2026-04-01 23:59:59"}}' \
  http://127.0.0.1:22499/api/history-order-fills

POST /api/history-orders

proto_id: TRD_GET_HISTORY_ORDER_LIST (2221)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1},"begin_time":"2026-01-01 00:00:00","end_time":"2026-04-01 23:59:59"}}' \
  http://127.0.0.1:22499/api/history-orders

GET /api/list-accounts

proto_id: TRD_GET_ACC_LIST (2001)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/api/list-accounts

POST /api/margin-info

proto_id: TRD_GET_MARGIN_INFO (22704)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1}}}' \
  http://127.0.0.1:22499/api/margin-info

POST /api/margin-ratio

proto_id: TRD_GET_MARGIN_RATIO (2223)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1},"symbols":["HK.00700"]}}' \
  http://127.0.0.1:22499/api/margin-ratio

POST /api/max-trd-qtys

proto_id: TRD_GET_MAX_TRD_QTYS (2111)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1},"code":"00700","price":300.0,"order_type":1}}' \
  http://127.0.0.1:22499/api/max-trd-qtys

POST /api/order-fee

proto_id: TRD_GET_ORDER_FEE (2225)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1},"order_id_ex_list":["987"]}}' \
  http://127.0.0.1:22499/api/order-fee

POST /api/order-fills

proto_id: TRD_GET_ORDER_FILL_LIST (2211)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1}}}' \
  http://127.0.0.1:22499/api/order-fills

POST /api/orders

proto_id: TRD_GET_ORDER_LIST (2201)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1}}}' \
  http://127.0.0.1:22499/api/orders

POST /api/positions

proto_id: TRD_GET_POSITION_LIST (2102)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1}}}' \
  http://127.0.0.1:22499/api/positions

POST /api/reconfirm-order

proto_id: TRD_RECONFIRM_ORDER (2237)

Scope: trade:real or trade:simulate (based on env)

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456},"order_id":"987","reconfirm_op":1}}' \
  http://127.0.0.1:22499/api/reconfirm-order

GET /api/token-state

proto_id: GET_TOKEN_STATE (1326)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/api/token-state

POST /api/token-state

proto_id: GET_TOKEN_STATE (1326)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456}}}' \
  http://127.0.0.1:22499/api/token-state

交易写入

下单、改单 / 撤单、一键撤全部、解锁交易 cipher、账户 push 订阅。下单 / 撤改单需 trade:realtrade:simulate (env 二次校验) + --enable-trading;解锁交易 (/api/unlock-trade) v1.4.104+ 严格要求 trade:unlock (其它 trade super-scope 不再视为兼容)。

POST /api/cancel-all-order

proto_id: TRD_MODIFY_ORDER (2205)

Scope: trade:real or trade:simulate (based on env)

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1}}}' \
  http://127.0.0.1:22499/api/cancel-all-order

POST /api/modify-order

proto_id: TRD_MODIFY_ORDER (2205)

Scope: trade:real or trade:simulate (based on env)

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_market":1},"order_id":"987","op":1}}' \
  http://127.0.0.1:22499/api/modify-order

POST /api/order

proto_id: TRD_PLACE_ORDER (2202)

Scope: trade:real or trade:simulate (based on env)

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"c2s":{"header":{"acc_id":123456,"trd_env":1,"trd_market":1},"side":1,"code":"00700","qty":100,"price":300.0}}' \
  http://127.0.0.1:22499/api/order

POST /api/sub-acc-push

proto_id: — (non-proto / 无 backend 转发)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"acc_id_list":[123456]}' \
  http://127.0.0.1:22499/api/sub-acc-push

POST /api/unlock-trade

proto_id: TRD_UNLOCK_TRADE (2005)

Scope: trade:unlock

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"unlock":true,"pwd_md5":"<md5-of-trade-password>"}' \
  http://127.0.0.1:22499/api/unlock-trade

POST /api/unsub-acc-push

proto_id: — (non-proto / 无 backend 转发)

Scope: acc:read

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{"acc_id_list":[123456]}' \
  http://127.0.0.1:22499/api/unsub-acc-push

管理 (admin)

守护进程管理 endpoint。需 admin scope。

POST /api/admin/reload

proto_id: — (non-proto / 无 backend 转发)

Scope: admin

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{}' \
  http://127.0.0.1:22499/api/admin/reload

POST /api/admin/shutdown

proto_id: — (non-proto / 无 backend 转发)

Scope: admin

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -X POST -H 'Authorization: Bearer $FUTU_API_KEY' -H 'Content-Type: application/json' \
  -d '{}' \
  http://127.0.0.1:22499/api/admin/shutdown

GET /api/admin/status

proto_id: — (non-proto / 无 backend 转发)

Scope: admin

参数 / 返回: 见 proto 定义. 字段 snake_case, 支持 v1.4.83+ alias + v1.4.84+ enum int/string 双接.

示例:

curl -H 'Authorization: Bearer $FUTU_API_KEY' \
  http://127.0.0.1:22499/api/admin/status


更多信息