Pry::Ib

This gem is a Pry plugin which provides a CLI for interacting with the Interactive Brokers API . It is esstially a mashup of Pry and the excellent ib-ruby gem which does the direct communication with Interactive Brokers API. Intended for creating and testing small trading automations with the Interactive Brokers API.

Version

Version 0.0.4 -- Pre-alpha -- definitely a work in progress

Installation

Add this line to your application's Gemfile:

gem 'pry-ib'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pry-ib

Configuration

In the ~/.pryc the the port host can be set TWS or Gateway being used. For security reasons, Interactive browser makes multiple TWS and Gateways reside on the same host. Currently, up to 3 separate are supported known as "live", "test", "gateway". However, they can be either TWS or Gateway are just arbitray names given to the ports

# File: ~/.pryrc

Pry.config.ib_host = '127.0.0.1'
Pry.config.ib_live_port = 7442
Pry.config.ib_test_port = 7496
Pry.config.ib_gateway_port = 4001

Usage

> bundle exec pry
IB: main(0)> help pry-ib
pry-ib
  account            Get account info
  alert              Setup an alert
  bracket            Execute bracket order
  chart              Get chart from stock quotes
  connection         Connection -- manage ib client connection
  contract           Get contract info
  order              Get order status
  quote              Get quote history
  real               Get real time quote
  scan               Run scanneer
  subs               Enable ib alerts
  tick               Get tick quote


IB: main(0)>
IB(): main(0)> connection -h
connection -- manage IB client connection
    -s, --show         show services
    -c, --close        close current connection
    -o, --host         host
    -b, --subs         subscribers
    -u, --unsub        unsubscribe id
        --service      set Service name
    -l, --live         use Live Service
    -t, --test         use Test Service
    -g, --gateway      use Gateway Service
    -h, --help         Show this message.
IB(): main(0)>
IB(): main(0)> connection --test
15:35:51.086 ---- Connect: tws_test. options:{:client_id=>nil, :host=>"127.0.0.1", :port=>7496, :service=>:tws_test}
15:35:51.089 Connected to server, ver: 71, connection time: 2014-08-17 15:35:51 -0700 local, 20140817 15:35:50 PST remote.

IB(TEST): main(0)> tick -h
Get Tick quote
        --num       Number of ticks. (Default: 2)
    -h, --help      Show this message.
IB(TEST): main(0)> tick fb
07:49:35.478
******** Tick Start: fb *********
07:49:35.479 ---- tick count: 0 ---- 
07:49:35.678 [0] TickPrice  T:last   Price: 75.11 Size:5
07:49:35.679 [0] TickPrice  T:high   Price: 75.26 Size:0
07:49:35.680 [0] TickPrice  T:low    Price: 73.07 Size:0
07:49:35.680 [0] TickPrice  T:close  Price: 74.58 Size:0
07:49:35.681 [0] TickPrice  T:open   Price: 73.52 Size:0
07:49:35.681 [0] TickPrice  T:bid    Price: 75.1 Size:23
07:49:35.682 [0] TickPrice  T:ask    Price: 75.11 Size:4

IB(LIVE): main(0)> alert -h
Usage: alert symbol | { |bar| bar.close > 42 }
Example:
  alert aapl | { |bar| bar.close > 42 }
  
        --name       set alert name
    -l, --list       list alerts
    -s, --sound      Use audio alert
    -h, --help       Show this message.
IB(LIVE): main(0)>
IB(LIVE): main(0)> alert AAPL | {|bar| bar.close > 142 }

TODO: Write usage instructions here

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

See Also

IB API

ib-ruby project

Pry