跳转到内容

TWS API 文件位置和工具

安装完 TWS API 后,先不要急着写策略。先确认目录结构和示例工具都在。

路径含义
C:\JtsWindows 上常见的 TWS 客户端安装目录。
C:\TWS API官方文档常用的 Windows TWS API 包示例目录。
其他自定义路径如果安装时选择了其他盘符或目录,以实际路径为准。
~/IBJtsMac / Linux 上常见的 TWS API 解压目录。

如果只有 C:\Jts,通常说明你安装了 TWS 客户端,但不代表已经安装 TWS API 包。TWS 客户端目录和 API 源码包目录是分开的,用户应以自己机器上的实际安装目录为准。

文件Windows 常见路径用途
API_VersionNum.txtAPI_ROOT\API_VersionNum.txt查看 API 包版本。
IBSampleApp.exeAPI_ROOT\samples\CSharp\IBSampleApp\bin\Release\IBSampleApp.exe手动测试 API 功能的 C# 示例程序。
ApiDemo.jarAPI_ROOT\samples\Java\ApiDemo.jarJava 示例测试程序。
Python clientAPI_ROOT\source\pythonclientPython API 源码和安装目录。

Mac / Linux 下路径通常对应到:

~/IBJts/source
~/IBJts/samples

Windows:

Terminal window
set "API_ROOT=C:\TWS API"
dir "%API_ROOT%"
type "%API_ROOT%\API_VersionNum.txt"

macOS / Linux:

Terminal window
test -f ~/IBJts/API_VersionNum.txt
cat ~/IBJts/API_VersionNum.txt

Python 包检查:

Terminal window
py -c "import ibapi; print(ibapi.__file__)"

macOS / Linux:

Terminal window
python3 -c "import ibapi; print(ibapi.__file__)"

参考检查结果:

API_VersionNum.txt -> API_Version=10.47.01
Python 能导入 ibapi
工具适合谁作用
IBSampleApp.exeC# / Windows 用户用界面方式测试连接、合约、行情和订单相关功能。
ApiDemo.jarJava 用户测试 Java API 调用。
source/pythonclientPython 用户安装 ibapi,运行本文档中的 Python 示例。

示例工具只能证明“API 客户端能运行”。真正连接成功仍然取决于 TWS / IB Gateway 是否已经登录、是否开启 Socket API、端口是否正确。

路径作用
TWS / IB Gateway 安装目录运行交易终端或网关。
TWS API 包目录存放 source\pythonclientsamples 和版本文件。
项目虚拟环境目录你的策略或示例代码实际使用的 Python 环境。

新手常见错误是把这三个路径混在一起。判断方式很简单:

  • 能打开交易界面的目录,不一定有 API 源码。
  • source\pythonclient 的目录,才是 API 包目录。
  • import ibapi 打印出来的路径,才是运行脚本的 Python 实际使用的包位置。

Python 示例遵守这条规则:

  • 示例代码里的类名、方法名、字段名保持官方英文。
  • 注释和解释使用中文。
  • 如果是连接、行情、合约、订单相关示例,优先使用模拟账户实测结果。
  • 如果缺少权限或环境,应展示真实错误或说明限制,不把示例写成已经成功返回业务数据。

官方 TWS API File Location & Tools 章节列出 API_VersionNum.txtIBSampleApp.exeApiDemo.jar 的用途;官方安装章节说明 Windows API 目录通常为 C:\TWS API,Mac / Linux 解压后通常进入 ~/IBJts