IB-Ruby 项目下载及安装教程

1. 项目介绍

IB-Ruby 是一个纯 Ruby 实现的 Interactive Brokers (IB) Trader Workstation (TWS) API 接口。它通过直接使用 socket API 与 TWS 服务器通信，因此不需要任何额外的依赖，除了 TWS/Gateway 本身。IB-Ruby 支持 API 版本 973.04，提供了基本的订单原型、价差原型和账户抽象功能。它适用于快速查询，但不建议用于 24/7 的应用程序。

2. 项目下载位置

IB-Ruby 项目托管在 GitHub 上，可以通过以下命令进行下载：

git clone https://github.com/ib-ruby/ib-ruby.git

3. 项目安装环境配置

3.1 环境要求

• Ruby 解释器，至少需要版本 2.4，推荐使用 2.5 或更高版本。
• Interactive Brokers 的连接软件：TWS 或 Gateway。
• 配置 TWS 或 Gateway 以允许从运行 IB-Ruby 的计算机进行 API 连接。

3.2 配置示例

3.2.1 安装 Ruby

确保系统中已安装 Ruby，可以通过以下命令检查 Ruby 版本：

ruby -v

如果未安装，可以使用以下命令安装：

# 对于 Ubuntu/Debian 系统
sudo apt-get install ruby-full

# 对于 macOS 系统
brew install ruby

3.2.2 配置 TWS 或 Gateway

1. 启动 TWS 或 Gateway。
2. 在 TWS 或 Gateway 的设置中，确保启用了 API 连接，并允许从本地计算机进行连接。

3.3 环境配置图片示例

由于无法直接插入图片，请参考以下步骤进行配置：

1. 打开 TWS 或 Gateway。
2. 进入 Global Configuration -> API -> Settings。
3. 启用 Enable ActiveX and Socket Clients 选项。
4. 确保 Socket Port 设置为默认的 4002（Gateway）或 7497（TWS）。

4. 项目安装方式

4.1 使用 Bundler 安装

进入项目目录并执行以下命令：

cd ib-ruby
bundle install

4.2 手动安装

如果不想使用 Bundler，可以直接安装依赖的 gem：

gem install ib-ruby

5. 项目处理脚本

IB-Ruby 提供了一个简单的示例脚本，用于请求账户数据并下订单。以下是一个基本的示例脚本：

require 'ib-ruby'

ib = IB::Connection.new(port: 7497) do |gw|
  gw.subscribe(:Alert, :AccountValue) { |msg| puts msg.to_human }
  gw.subscribe(:OpenOrder) { |msg| puts "Placed: #{msg.order}" }
  gw.subscribe(:ExecutionData) { |msg| puts "Filled: #{msg.execution}" }
end

ib.send_message :RequestAccountData, account_code: 'U123456'
ib.wait_for :AccountDownloadEnd

contract = IB::Stock.new(symbol: 'WFC')
buy_order = IB::LimitOrder.new(size: 100, price: 21.00, action: :buy, tif: :good_till_cancelled, account_code: 'U123456')

ib.place_order buy_order, contract
ib.wait_for :ExecutionData

5.1 脚本说明

• IB::Connection.new(port: 7497)：创建与 TWS 或 Gateway 的连接。
• gw.subscribe：订阅特定的事件，如账户值变化、订单状态变化等。
• ib.send_message：发送请求账户数据的指令。
• ib.place_order：下订单。
• ib.wait_for：等待特定事件的发生。

通过以上步骤，您可以成功下载、安装并运行 IB-Ruby 项目。