The Kite Connect API Python client

The official Python client for communicating with the Kite Connect API.

Kite Connect is a set of REST-like APIs that expose many capabilities required to build a complete investment and trading platform. Execute orders in real time, manage user portfolio, stream live market data (WebSockets), and more, with the simple HTTP API collection.

Rainmatter (c) 2016. Licensed under the MIT License.

Documentation

• Python client documentation
• Kite Connect HTTP API documentation

Installing the client

pip install kiteconnect

API usage

from kiteconnect import KiteConnect

kite = KiteConnect(api_key="your_api_key")

# Redirect the user to the login url obtained
# from kite.login_url(), and receive the request_token
# from the registered redirect url after the login flow.
# Once you have the request_token, obtain the access_token
# as follows.

data = kite.request_access_token("request_token_here", secret="your_secret")
kite.set_access_token(data["access_token"])

# Place an order
try:
	order_id = kite.order_place(tradingsymbol="INFY",
					exchange="NSE",
					transaction_type="BUY",
					quantity=1,
					order_type="MARKET",
					product="NRML")

	print("Order placed. ID is", order_id)
except Exception as e:
	print("Order placement failed", e.message)

# Fetch all orders
kite.orders()

# Get instruments
kite.instruments()

# Place an mutual fund order
kite.mf_order_place(
	tradingsymbol="INF090I01239",
	transaction_type="BUY",
	amount=5000,
	tag="mytag"
)))

# Cancel a mutual fund order
kite.mf_order_cancel(order_id="order_id")

# Get mutual fund instruments
kite.mf_instruments()

Refer to the Python client documentation for the complete list of supported methods.

WebSocket usage

from kiteconnect import WebSocket

# Initialise.
kws = WebSocket("your_api_key", "your_public_token", "logged_in_user_id")

# Callback for tick reception.
def on_tick(tick, ws):
	print tick

# Callback for successful connection.
def on_connect(ws):
	# Subscribe to a list of instrument_tokens (RELIANCE and ACC here).
	ws.subscribe([738561, 5633])

	# Set RELIANCE to tick in `full` mode.
	ws.set_mode(ws.MODE_FULL, [738561])

# Assign the callbacks.
kws.on_tick = on_tick
kws.on_connect = on_connect

# To enable auto reconnect WebSocket connection in case of network failure
# - First param is interval between reconnection attempts in seconds.
# Callback `on_reconnect` is triggered on every reconnection attempt. (Default interval is 5 seconds)
# - Second param is maximum number of retries before the program exits triggering `on_noreconnect` calback. (Defaults to 50 attempts)
# Note that you can also enable auto reconnection	 while initialising websocket.
# Example `kws = WebSocket("your_api_key", "your_public_token", "logged_in_user_id", reconnect=True, reconnect_interval=5, reconnect_tries=50)`
kws.enable_reconnect(reconnect_interval=5, reconnect_tries=50)

# Infinite loop on the main thread. Nothing after this will run.
# You have to use the pre-defined callbacks to manage subscriptions.
kws.connect()

Generate documentation

pip install pdoc

pdoc --html --html-dir docs kiteconnect

Changelog

• 2015-07-15 Fixed: Different response type recevied for large number of subscriptions
• 2016-05-31 Added WebSocket class for streaming data.
• 2016-04-29 instruments() call now returns parsed CSV records.
• 2016-05-04 Added historical() call.
• 2016-05-09 Added parent_order_id param for multi-legged orders.
• 2016-07-25 Option to disable SSL cert verification (Ubuntu 12.04 openssl bug)
• 2016-08-26 Full compatability for Python 3
• 2016-10-21 Released version 3.3 with following fixes and features * Added tag support to order APIs * Added proxy support for api and websocket streaming * Fixed market depth orders integer overflow issue.
• 2016-11-11 Added connection pooling (v3.4)
• 2017-01-21 Bug fixes (v3.4.1)
• 2017-04-25 Added auto reconnect feature and other bug fixes (v3.5)
• 2017-08-01 Fix BO and CO order modify issue (v3.5.1)
• 2017-08-15 Add mutual fund API calls (v3.6.0)
• 2017-09-14 Addd flag to fetch continous chart and other bug fixes (v3.6.1)