Python wrapper for Interactive Brokers Client Portal Web API
Project description
EasyIB: Unofficial Wrapper for Interactive Brokers API
EasyIB is an unofficial python wrapper for Interactive Brokers Client Portal Web API. 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()
# By default, easyib assumes the gateway session is at local port 5000 without a ssl certificate
# A custom port may be set by `api = easyib.REST(url="https://localhost:5000", ssl=False)`
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",
}
]
# For order parameters, see 'order request info' at https://www.interactivebrokers.com/api/doc.html#tag/Order/paths/~1iserver~1account~1{accountId}~1orders/post
api.submit_orders(list_of_orders)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
easyib-0.0.4.tar.gz
(4.4 kB
view hashes)
Built Distribution
easyib-0.0.4-py3-none-any.whl
(4.7 kB
view hashes)