easyib 0.0.6

Python wrapper for Interactive Brokers Client Portal Web API

EasyIB is an unofficial python wrapper for Interactive Brokers Client Portal Web API.

Features

Notable functionality includes:

• Pull account info, portfolio, cash balance, net value

• Pull market historical data

• Submit, modify, cancel orders

• Get order status, list of live orders

• Ping (tickle) server, get authentication status, re-authenticate

How to install

pip install easyib

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 be also used for setting up an active session.

Quick start

Historical data

import easyib

api = easyib.REST()

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

Submitting an order

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

api.submit_orders(list_of_orders)

Reference

REST

By default, EasyIB assumes the gateway session is open at “https://localhost:5000” withtout a SSL certificate. A custom url and SSL certificate can be set by:

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

API REST Methods

Title

REST Method	End Point	Result
get_account()	Get portfolio/accounts	list
switch_account(accountId: str)	Post iserver/account/{accoutId}	dict
get_cash()	Get portfolio/{accountId}/ledger	float
get_netvalue()	Get portfolio/{accountId}/ledger	float
get_conid(symbol: str)	Get trsv/stocks	int
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/satus/	dict
get_live_orders(filters=[])	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)	Get iserver/marketdata/history	dict