Web API 参考总览
IBKR Web API 是 HTTP / WebSocket 风格的接口体系，和 TWS API 的本地 Socket 模型不同。官方入口是 Web API Reference。
官方说明中，统一版 Web API 文档与 Reference 仍处于 beta，既有的 Client Portal Web API、Digital Account Management 和 Flex Web Service 文档仍然保留。因此阅读 Web API 时要先分清“接口家族”，不要把所有 Web 入口都当成同一个认证方式或同一套 endpoint。
截至 2026 年 6 月，官方 Web API 资料可以按三条线理解：Trading Web API 处理交易、账户、行情和订单；Account Management Web API 处理开户注册、账户维护、资金与报表等运营流程；Flex Web Service 处理预配置报表下载。Client Portal Gateway 仍是个人客户验证 Web API 的常见入口。
三类 Web API
Section titled “三类 Web API”| 类型 | 中文理解 | 主要用途 | 认证与环境 |
|---|---|---|---|
| Trading Web API | 交易 Web API | 会话认证、账户、组合、合约、行情、订单、成交、通知等交易相关能力。 | 以 HTTPS / JSON 为主，统一 Web API 方向使用 OAuth 2.0；Client Portal API 路线通常涉及 Gateway 会话。 |
| Account Management Web API | 账户管理 Web API | 开户、客户资料维护、资金与银行、报表等账户运营能力。 | 面向 Introducing Broker、Financial Advisor 等机构场景，部分能力需要审批或配置。 |
| Flex Web Service | Flex 报表服务 | 按预先配置的 Flex Query 拉取报表 XML。 | 使用 Flex Token + Query ID，不用于实时行情或下单。 |
先确认接入身份
Section titled “先确认接入身份”| 身份 | 推荐先看 | 原因 |
|---|---|---|
| 个人交易者 / 模拟账户开发 | TWS API、Client Portal Gateway、Trading Web API | 可以先用本地登录会话验证账户、合约和订单链路。 |
| FA / Introducing Broker | Trading Web API、Account Management Web API、SSO | 通常涉及客户管理、授权、账户运营和合规流程。 |
| 第三方软件服务商 | Trading Web API、OAuth 1.0a / OAuth 2.0、审批流程 | 往往需要合规审批、应用注册、公钥和回调地址。 |
| 对账 / 报表系统 | Flex Web Service | 目标是下载报表，不是盘中交易。 |
和 TWS API 的核心区别
Section titled “和 TWS API 的核心区别”| 对比项 | TWS API | Web API |
|---|---|---|
| 通信方式 | 本地 TCP Socket | HTTPS / WebSocket |
| 运行依赖 | TWS 或 IB Gateway 必须登录 | 取决于 OAuth、Gateway 或 Flex Token |
| 数据模型 | EClient 发请求，EWrapper 收回调 | HTTP method、endpoint、JSON body、JSON/XML response |
| 适合场景 | 低延迟交易程序、桌面或服务器连接 TWS/IB Gateway | Web 服务、账户管理、报表、机构系统集成 |
| 常见难点 | 端口、clientId、回调、断线重连、行情权限 | OAuth、会话、权限审批、endpoint 版本、HTTP 错误处理 |
如果目标是先做可运行的模拟交易原型，优先读 TWS API 章节，因为它可以通过 TWS 模拟账户跑通连接、合约、行情、历史数据和订单。
如果目标是做 Web 服务、面向多个用户的系统、账户管理流程或报表下载，再读本目录。Web API 页面会优先解释接口边界、字段含义和认证要求；对于需要 OAuth、Token 或机构审批的接口，示例以请求结构和字段说明为主，不假设读者已经具备对应权限。
| 官方资料 | 入口 |
|---|---|
| Web API Documentation | Web API Documentation |
| Web API Reference | Web API Reference |
| Account Management Web API | Account Management Web API |
| Flex Web Service | Flex Web Service |