Skip to main content

The official Python client for the Kite Connect trading API

Project description

# The Kite Connect API Python client - v3
[![Build Status](](
[![Windows Build Status](](

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.

[Zerodha Technology]( (c) 2018. Licensed under the MIT License.

## Documentation
- [Python client documentation](
- [Kite Connect HTTP API documentation](

## Installing the client
You can install the pre release via pip
pip install --upgrade kiteconnect

Its recommended to update `setuptools` to latest if you are facing any issue while installing

pip install -U pip setuptools

Since some of the dependencies uses C extensions it has to compiled before installing the package.

### Linux, BSD and macOS
- On Linux, and BSDs, you will need a C compiler (such as GCC).

#### Debian/Ubuntu
apt-get install libffi-dev python-dev python3-dev
#### Centos/RHEL/Fedora
yum install libffi-devel python3-devel python-devel
#### macOS/OSx
xcode-select --install

### Microsoft Windows
Each Python version uses a specific compiler version (e.g. CPython 2.7 uses Visual C++ 9.0, CPython 3.3 uses Visual C++ 10.0, etc). So, you need to install the compiler version that corresponds to your Python version
- Python 2.6, 2.7, 3.0, 3.1, 3.2 - [Microsoft Visual C++ 9.0](
- Python 3.3, 3.4 - [Microsoft Visual C++ 10.0](
- Python 3.5, 3.6 - [Microsoft Visual C++ 14.0](

For more details check [official Python documentation](

## API usage
import logging
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.generate_session("request_token_here", api_secret="your_secret")

# Place an order
order_id = kite.place_order(tradingsymbol="INFY",
product=kite.PRODUCT_NRML)"Order placed. ID is: {}".format(order_id))
except Exception as e:"Order placement failed: {}".format(e.message))

# Fetch all orders

# Get instruments

# Place an mutual fund order

# Cancel a mutual fund order

# Get mutual fund instruments

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

## WebSocket usage
import logging
from kiteconnect import KiteTicker


# Initialise
kws = KiteTicker("your_api_key", "your_access_token")

def on_ticks(ws, ticks):
# Callback to receive ticks.
logging.debug("Ticks: {}".format(ticks))

def on_connect(ws, response):
# Callback on successful connect.
# 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])

def on_close(ws, code, reason):
# On connection close stop the main loop
# Reconnection will not happen after executing `ws.stop()`

# Assign the callbacks.
kws.on_ticks = on_ticks
kws.on_connect = on_connect
kws.on_close = on_close

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

# Run unit tests

python test


pytest -s tests/unit --cov-report html:cov_html --cov=./

# Run integration tests

pytest -s tests/integration/ --cov-report html:cov_html --cov=./ --api-key api_key --access-token access_token

# Generate documentation

pip install pdoc

pdoc --html --html-dir docs kiteconnect

## Changelog


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for kiteconnect, version 3.7.7
Filename, size & hash File type Python version Upload date
kiteconnect-3.7.7.tar.gz (21.9 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page