utilmon / easyib

Python wrapper for Interactive Brokers Client Portal Web API

EasyIB: Python Wrapper for Interactive Brokers API

"Logo for 'EasyIB'" according to Midjourney

EasyIB is an unofficial python wrapper for Interactive Brokers Client Portal Web API. The motivation for the project was to build a Python wrapper that can run on Linux/cloud environments. Thus, Client Portal API was preferred over Trader Workstation (TWS) API.

Please see https://easyib.readthedocs.io for the full documentation.

Features

Notable functionality includes:

• Pull account info, portfolio, cash balance, the net value
• Pull historical market data
• Submit, modify, cancel orders
• Get order status, list of live orders
• Ping (tickle) server, get authentication status, re-authenticate

How to install

EasyIB assumes a gateway session is active and authenticated. Follow instructions at https://interactivebrokers.github.io/cpwebapi/ for authentication. A custom package such as Voyz/IBeam can also be used for setting up an active session. Part Time Larry has an excellent youtube tutorial on this topic: https://www.youtube.com/watch?v=O1OhiiCx6Ho.

EasyIB was developed under the Voyz/IBeam docker image environment. You can verify if a gateway session is active by typing curl -X GET "https://localhost:5000/v1/api/one/user" -k at bash terminal.

Once a gateway session is running, pip command can be used to install EasyIB:

pip install easyib

Quick start

Historical data

import easyib

ib = easyib.REST() # default parameters: url="https://localhost:5000", ssl=False

bars = ib.get_bars("AAPL", period="1w", bar="1d")
print(bars)

Submitting an order

list_of_orders = [
    {
        "conid": ib.get_conid("AAPL"),
        "orderType": "MKT",
        "side": "BUY",
        "quantity": 7,
        "tif": "GTC",
    }
]

order = ib.submit_orders(list_of_orders)
print(order)

Reference

For the complete reference, please visit https://easyib.readthedocs.io/en/latest/reference.html.

REST

By default, EasyIB assumes the gateway session is open at https://localhost:5000 without an SSL certificate. A custom URL and SSL certificate can be set by:

ib = easyib.REST(url="https://localhost:5000", ssl=False)

API REST Methods

Documentation of available functions is at https://easyib.readthedocs.io/en/latest/reference.html.

See the official documentation of the End Point at https://www.interactivebrokers.com/api/doc.html.

REST Method	End Point	Result
get_accounts()	Get portfolio/accounts	list
switch_account(accountId: str)	Post iserver/account/{accountId}	dict
get_cash()	Get portfolio/{accountId}/ledger	float
get_netvalue()	Get portfolio/{accountId}/ledger	float
get_conid(symbol: str, instrument_filters: Dict = None, contract_filters: Dict = {"isUS": True})	Get trsv/stocks	int
get_fut_conids(symbol: str)	Get trsv/futures	list
get_portfolio()	Get portfolio/{accountId}/positions/0	dict
reply_yes(id: str)	Post iserver/reply/{id}	dict
submit_orders(list_of_orders: list, reply_yes=True)	Post iserver/account/{acountId}/orders	dict
get_order(orderId: str)	Get iserver/account/order/status/	dict
get_live_orders(filters=None)	Get iserver/account/orders	dict
cancel_order(orderId: str)	Delete iserver/account/{accountId}/order/{orderId}	dict
modify_order(orderId=None, order=None, reply_yes=True)	Post iserver/account/{accountId}/order/{orderId}	dict
get_bars(symbol: str, period="1w", bar="1d", outsideRth=False, conid="default")	Get iserver/marketdata/history	dict
ping_server()	Post tickle	dict
get_auth_status()	Post iserver/auth/status	dict
re_authenticate()	Post iserver/reauthenticate	None
log_out()	Post logout	None

easyib's Issues

Key error on placing order

Hi, when I try to create an order I'm getting this message (not always). It's something to do with how it's handling the response during the "reply all" flow (if the response has no position 0). Any thoughts please? Thanks!

placing order for AAPL
Traceback (most recent call last):
  File "/home/xxx/minute_screener_update_dev.py", line 660, in create_order
    response = api.submit_orders(orders, True)
  File "/home/xxx/.local/lib/python3.9/site-packages/easyib/easyib.py", line 191, in submit_orders
    return self._reply_all_yes(response, reply_yes)
  File "/home/xxx/.local/lib/python3.9/site-packages/easyib/easyib.py", line 167, in _reply_all_yes
    dic = response.json()[0]
KeyError: 0

Trading TWS session is connected from a different IP address

Hi!

I wanted to try this library but when I try the sample code I just receive this error:

{'error': 'Trading TWS session is connected from a different IP address'}

Any idea about if this is a bug or theres something wrong?

get_bars() not working

This is very nice work! I tried most of the functions and they work well, however, when I run the get_bars() example I get the following error:

Traceback (most recent call last):
  File "test.py", line 30, in <module>
    bars = ib.get_bars("AAPL", period="1w", bar="1d")
  File "/home/rod/Projects/tradingview/ibapi.py", line 252, in get_bars
    return response.json()
  File "/home/rod/Projects/tradingview/venv/lib/python3.8/site-packages/requests/models.py", line 910, in json
    return complexjson.loads(self.text, **kwargs)
  File "/usr/lib/python3.8/json/__init__.py", line 357, in loads
    return _default_decoder.decode(s)
  File "/usr/lib/python3.8/json/decoder.py", line 337, in decode
    obj, end = self.raw_decode(s, idx=_w(s, 0).end())
  File "/usr/lib/python3.8/json/decoder.py", line 355, in raw_decode
    raise JSONDecodeError("Expecting value", s, err.value) from None
json.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)

Is it possible to get streaming market data with ibeam?

how would one use ibeam to get a continuous stream of market data (or is it not currently possible)? It is easy to do with the native api but it requires the gateway UI to be open, which is quite inconvenient.

Is there some way to pull fundamentals (eg ROA) for multiple stocks?

Looks like it’s possible on TWS but can’t see it in the api endpoints. I’m trying to build a screener. Thanks!

how to get futures data and place orders

As I mainly trade futures I am wondering how to get futures data and place orders? Doing the following:

bars = ib.get_bars("NG", period="1w", bar="1d")
print(bars)

Results in the following error:

{'error': "No data of type EODChart is available for the exchange 'VALUE' and the security type 'Stock' and '1 W' and '1 day'"}

Using ibapi the sequence would go something like this:

contract = Contract()
contract.symbol = 'NG'
contract.exchange = 'NYMEX'
# contract.secType = 'CONTFUT'
contract.secType = 'FUT'
contract.lastTradeDateOrContractMonth  = '202109'

app.reqHistoricalData(1, contract, '20210815 17:59:00', '10 D', '15 mins', 'BID', 0, 2, False, [])

How would this be done using EasyIB?

Can't get portfolio

Hi, I keep getting the error below when I try to get my portfolio. This is a new paper account with no portfolio in place yet, so I'd expect it to return an empty portfolio instead of an error? I've tried restarting ibeam and my server but the error persists. Other service calls work. Any ideas much appreciated! Thanks

Traceback (most recent call last):
  File "/home/xxx/test.py", line 72, in <module>
    print(api.get_portfolio())
  File "/home/xxx/.local/lib/python3.9/site-packages/easyib/easyib.py", line 98, in get_portfolio
    for item in response.json():
  File "/usr/lib/python3/dist-packages/requests/models.py", line 900, in json
    return complexjson.loads(self.text, **kwargs)
  File "/usr/lib/python3.9/json/__init__.py", line 346, in loads
    return _default_decoder.decode(s)
  File "/usr/lib/python3.9/json/decoder.py", line 337, in decode
    obj, end = self.raw_decode(s, idx=_w(s, 0).end())
  File "/usr/lib/python3.9/json/decoder.py", line 355, in raw_decode
    raise JSONDecodeError("Expecting value", s, err.value) from None
json.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)

Is EasyIB still working?

I am using a PAPER account for the test.

Some of requests work, but some of them do not work.
Do you have any idea how to fix them?

① Get live orders

Response:
{'error': 'Please query /accounts first'}

② Get auth status, Get ping server
→ This one works, but why I am not still authenticated?

Response:
{'authenticated': False,
'competing': False,
'connected': False,
'MAC': 'F4:03:43:DA:99:00'}

{'session': '8ce8747753be3a9f1bebe610b3b743 c6',
'ssoExpires': 0,
'collission': False,
'userId': 102651152,
'hmds': {'error': 'no bridge'},
'iserver': {'authStatus': {'authenticated': False,
'competing': False,
'connected': False,
'MAC': 'F4:03:43:DA:99:00'}}}

③ Switch account

Response:
{'error': 'Init session first', 'statusCode': 400}

④ Get Bars (market data)

Response:
{'error': 'Init session first', 'statusCode': 400}

Do you know how to avoid reply when place order?

It is very slow to place order with reply action.
cost more than 2s when I place a market order. Does any idea to speed up? thanks.