# ib

**Repository Path**: mirrors_dimchansky/ib

## Basic Information

- **Project Name**: ib
- **Description**: Pure Go interface to Interactive Brokers IB API
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-21
- **Last Updated**: 2026-01-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

GoIB
====

[![Build Status](https://drone.io/github.com/gofinance/ib/status.png)](https://drone.io/github.com/gofinance/ib/latest)
[![GoDoc](https://godoc.org/github.com/gofinance/ib?status.png)](https://godoc.org/github.com/gofinance/ib)
[![Coverage Status](https://coveralls.io/repos/gofinance/ib/badge.png?branch=master)](https://coveralls.io/r/gofinance/ib?branch=master)

This is a pure Go interface to
[Interactive Brokers](https://www.interactivebrokers.com/)
[IB API](http://interactivebrokers.github.io). Features include:

* 100% pure Go (no Java/C calls)
* Idiomatic design (Go naming conventions, channels, error handling etc)
* Choice of low-level types or our high-level [Manager](manager.go) types
* Extensively tested (test coverage via
  [Coveralls](https://coveralls.io/r/gofinance/ib?branch=master), CI via
  [Drone](https://drone.io/github.com/gofinance/ib/latest), local
  [test server](testserver/README.md))
* Documentation on [GoDoc](https://godoc.org/github.com/gofinance/ib)
* Reflects very up-to-date IB API version

We welcome your involvement and contributions! If you like the project, please
click the GitHub "Star" or "[Fork](../../fork)" button. We also invite you to
join the [contributor list](../../graphs/contributors) by submitting
[pull requests](../../pulls).

Status
------

* The code presently supports IB API 971.01 (latest as of March 2014)
* All reply types (see [ereader.go](ereader.go)) are supported
* Some request types (see [eclientsocket.go](eclientsocket.go)) require porting

Testing
-------

```go test``` requires IB Gateway be running at 127.0.0.1:4002 and providing
access to a financial advisor account. Always use a demo or paper trade
account, as the tests may modify your account.

The easiest way to start IB Gateway with a financial advisor demo account is to
use the test server. Have a look at the
[test server instructions](testserver/README.md) for all the details.

By default the tests produce no output. If you'd like to view engine
communication logs during test execution, set the ```IB_ENGINE_DUMP```
environment variable to any value. For example, ```IB_ENGINE_DUMP=t go test```.

If you fork this project and would like to configure Drone and Coveralls for
your fork, our [Drone instructions](drone.md) should be of help.

License
-------

This library is licensed under
[GNU Lesser General Public License](http://www.gnu.org/licenses/lgpl.html)
version 3.

**Static linking exception**: The copyright holders give you permission to link
this library with independent modules to produce an executable, regardless of
the license terms of these independent modules, and to copy and distribute
the resulting executable under terms of your choice, provided that you also
meet, for each linked independent module, the terms and conditions of the
license of that module. An independent module is a module which is not
derived from or based on this library. If you modify this library, you must
extend this exception to your version of the library.

* This library is safe for use in close-source applications. The LGPL
  share-alike terms do not apply to applications built on top of this library.
* You do not need a commercial license. The LGPL applies to the library's own
  source code, not your applications.