如何验证TWS API与IBKR连接及查询Client ID？

一、Client ID的定义与设置 #

Client ID不是系统分配的查询项，而是你自行定义的任意正整数（只要和当前TWS中其他API客户端的ID不重复即可，比如常用1、2、3这类简单数字）。

在TWS中完成API权限配置（必须步骤）：

1. 打开IBKR交易工作站，依次点击 编辑 → 全局配置 → API → 设置
2. 勾选「启用Active X和Socket客户端」
3. 在「已允许的IP地址」中添加本地IP（通常填127.0.0.1，或0.0.0.0允许所有IP）
4. 确认端口号：模拟盘默认7497，实盘默认7496，保持代码中端口与这里一致
5. 保存设置后重启TWS

二、验证API连接状态的方法 #

用Python编写极简测试脚本，快速确认连接是否成功（推荐使用ib_insync库，这是IBKR API最常用的Python封装）：

测试代码 #

from ib_insync import IB

# 初始化IB对象
ib = IB()

# 尝试连接，clientId填你自定义的数字，比如1
try:
    ib.connect(
        host='127.0.0.1',
        port=7497,  # 模拟盘用7497，实盘替换为7496
        clientId=1,
        timeout=30
    )
    print("✅ API连接成功")
    print(f"当前连接状态: {ib.isConnected()}")
    # 可选：获取关联账户信息进一步验证
    accounts = ib.managedAccounts()
    print(f"关联交易账户: {accounts}")
    
    # 测试完成后断开连接
    ib.disconnect()
except Exception as e:
    print(f"❌ 连接失败，错误详情: {str(e)}")

常见连接失败排查点 #

• TWS交易工作站未启动，或未完成上述API权限配置
• 端口号错误：混淆了模拟盘（7497）和实盘（7496）的端口
• Client ID重复：当前已有其他API客户端（比如另一个Python脚本、量化工具）使用了相同的Client ID
• 本地防火墙拦截了TWS的API端口
• ib_insync库版本与TWS API版本不兼容：尽量保持两者版本同步（可通过pip install --upgrade ib_insync更新库）

内容的提问来源于stack exchange，提问作者APAT2023