Skip to content

Repository files navigation

Bridgetown IB-Ruby plugin

This plugin enables the interaction with the TWS-API of Interactive Brokers

Installation

$ bundle add bridgetown-ib-ruby

Then add a file tws.yml to the config directory. This is an example:

# TWS/Gateway
#
# Enter Port values as part of the `host`-entry:
# 4001/7496 for active accounts
# 4002/7497 for demo account
---
:get_account_data: true
:serial_array: false
:host: localhost:4002
:watchlists: - :Spreads
- :Stillhalter
- :BuyAndHold :client_id: 2001

Include in the Initializer

The Bridgetown-Initializer parses config/initializers for each environment. If the console (bin/bt c) is run, the file is parsed once. If the development-server is used (bin/bt s) the initializer is parsed to render static pages and once again in server-mode. We have to prevent the first run:

# in config/initialisers.rbonly:server,:consoledoinit:"bridgetown-ib-ruby"end

If IB-Ruby-Objects should be present in server and static mode, omit the setting of client_id. Then IB::Connection connects with an arbitrary client-id and Bridgetown runs two instances of the software.

Access ib-ruby-Objects

IB::Gateway-methods are present via IB::Gateway.current.
To rely on ib-api the IB::Connection-object is present via IB::Connection.current.

IB::Contracts (IB::Stock, IB::Option, IB::Future, IB::Forex, ...) and IB::Spreads (IB::Strangle, IB::Straddle, IB::Calendar ...) are available. IB::Symbols and Watchlists are present as well as enhanced order-types ( IB::Limit.order, IB::Stop.order ...)

Additional Infos

There is a blog entry on topofocus.de (in german): https://topofocus.de/blog/bridgtown-plugin/

Contributing

  1. Fork it (https://github.com/bridgetownrb/bridgetown-activerecord/fork)
  2. Clone the fork using git clone to your local development machine.
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request

About

Plugin to access the Interactive Brokers TWS-API from Bridgetown

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages