PyKiteConnect

https://github.com/zerodha/pykiteconnect
Admin
PyKiteConnect is the official Python client library for the Kite Connect API, enabling developers to...
Tokens:56,680
Snippets:375
Trust Score:8
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### place_mf_sip usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-mutual-funds.md

Example call to place_mf_sip with a monthly SIP of 1000 for 12 instalments starting on day 5.

```python
resp = kite.place_mf_sip(
    tradingsymbol="INF090I01239",
    amount=1000,
    instalments=12,
    frequency="monthly",
    instalment_day=5,
)
```

--------------------------------

### Fetch equity margins example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-market-data.md

Example usage of the margins method to fetch equity margins and print available cash.

```python
equity_margins = kite.margins(kite.MARGIN_EQUITY)
print(equity_margins["available"]["cash"])
```

--------------------------------

### Install libffi and Python dev packages on Debian/Ubuntu

Source: https://github.com/zerodha/pykiteconnect/blob/master/README.md

Install the required C compiler and development headers on Debian/Ubuntu systems to build the C extensions used by the client.

```bash
apt-get install libffi-dev python-dev python3-dev
```

--------------------------------

### Install libffi and Python dev packages on CentOS/RHEL/Fedora

Source: https://github.com/zerodha/pykiteconnect/blob/master/README.md

Install the required C compiler and development headers on CentOS/RHEL/Fedora systems to build the C extensions used by the client.

```bash
yum install libffi-devel python3-devel python-devel
```

--------------------------------

### Install pykiteconnect via pip

Source: https://github.com/zerodha/pykiteconnect/blob/master/README.md

Install the pre-release version of pykiteconnect using pip. Upgrading setuptools is recommended if you encounter installation issues.

```bash
pip install --upgrade kiteconnect
```

--------------------------------

### place_gtt single order example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-gtt-margins.md

Example of placing a single GTT (GTT_TYPE_SINGLE) for SBIN with a limit order. It prints the trigger_id from the response.

```python
single_order = [{
    "exchange": "NSE",
    "tradingsymbol": "SBIN",
    "transaction_type": kite.TRANSACTION_TYPE_BUY,
    "quantity": 1,
    "order_type": "LIMIT",
    "product": "CNC",
    "price": 470,
}]
gtt = kite.place_gtt(
    trigger_type=kite.GTT_TYPE_SINGLE,
    tradingsymbol="SBIN",
    exchange="NSE",
    trigger_values=[470],
    last_price=473,
    orders=single_order,
)
print("trigger_id:", gtt["trigger_id"])
```

--------------------------------

### Place mutual fund order example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-mutual-funds.md

Example usage of place_mf_order to buy a mutual fund with amount 5000 and a tag. Prints the returned order_id from the response.

```python
resp = kite.place_mf_order(
    tradingsymbol="INF090I01239",
    transaction_type=kite.TRANSACTION_TYPE_BUY,
    amount=5000,
    tag="mytag",
)
print(resp["order_id"])
```

--------------------------------

### Fetch NSE instruments example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-market-data.md

Example usage of the instruments method to fetch NSE instruments and find the INFY instrument by tradingsymbol, then print its instrument token and lot size.

```python
nse_instruments = kite.instruments(kite.EXCHANGE_NSE)
infy = [i for i in nse_instruments if i["tradingsymbol"] == "INFY"][0]
print(infy["instrument_token"], infy["lot_size"])
```

--------------------------------

### Install Xcode command line tools on macOS

Source: https://github.com/zerodha/pykiteconnect/blob/master/README.md

Install the Xcode command line tools on macOS/OSx to provide the C compiler needed for building the C extensions.

```bash
xcode-select --install
```

--------------------------------

### place_gtt OCO order example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-gtt-margins.md

Example of placing an OCO (two-leg) GTT for SBIN with two sell orders. It catches and prints an InputException if the payload is invalid.

```python
from kiteconnect import exceptions

oco_orders = [
    {"exchange": "NSE", "tradingsymbol": "SBIN", "transaction_type": kite.TRANSACTION_TYPE_SELL,
     "quantity": 1, "order_type": "LIMIT", "product": "CNC", "price": 470},
    {"exchange": "NSE", "tradingsymbol": "SBIN", "transaction_type": kite.TRANSACTION_TYPE_SELL,
     "quantity": 1, "order_type": "LIMIT", "product": "CNC", "price": 480},
]
try:
    gtt = kite.place_gtt(
        trigger_type=kite.GTT_TYPE_OCO,
        tradingsymbol="SBIN",
        exchange="NSE",
        trigger_values=[470, 480],  # two triggers for OCO
        last_price=473,
        orders=oco_orders,
    )
except exceptions.InputException as e:
    print("Bad GTT payload:", e.message)
```

--------------------------------

### get_gtts usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-gtt-margins.md

Example of using kite.get_gtts() to retrieve and iterate over all GTTs, printing trigger_id, status, and condition for each.

```python
gtts = kite.get_gtts()
for t in gtts:
    print(t["trigger_id"], t["status"], t["condition"])
```

--------------------------------

### Generate documentation with pdoc

Source: https://github.com/zerodha/pykiteconnect/blob/master/README.md

Installs pdoc and generates HTML documentation for the kiteconnect module into the docs directory.

```sh
pip install pdoc

pdoc --html --html-dir docs kiteconnect
```

--------------------------------

### Basic KiteConnect initialization

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect.md

Basic initialization example. Creates a KiteConnect instance with only the API key and then sets the access token obtained after login.

```python
from kiteconnect import KiteConnect

kite = KiteConnect(api_key="your_api_key")
kite.set_access_token("your_access_token")
```

--------------------------------

### Upgrade pip and setuptools

Source: https://github.com/zerodha/pykiteconnect/blob/master/README.md

Upgrade pip and setuptools to the latest versions to avoid installation problems, especially when C extensions need to be compiled.

```bash
pip install -U pip setuptools
```

--------------------------------

### Advanced KiteConnect configuration with proxies and pool

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect.md

Advanced configuration example showing how to pass timeout, proxies, connection pool settings, and disable_ssl to the KiteConnect constructor.

```python
kite = KiteConnect(
    api_key="your_api_key",
    access_token="your_access_token",
    timeout=10,
    proxies={"http": "http://proxy.local:8080", "https": "http://proxy.local:8080"},
    pool={"pool_connections": 10, "pool_maxsize": 10, "max_retries": 3},
    disable_ssl=False,
)
```

--------------------------------

### Full ticker session example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/ticker.md

Full ticker session example from the Kite Connect documentation. It sets up logging, creates a KiteTicker instance with API key and access token, defines callbacks for ticks, connect, and close, subscribes to instruments, sets mode to full, and connects. The on_close callback stops the websocket to prevent reconnection.

```python
import logging
from kiteconnect import KiteTicker

logging.basicConfig(level=logging.DEBUG)
kws = KiteTicker("your_api_key", "your_access_token")

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

def on_connect(ws, response):
    ws.subscribe([738561, 5633])
    ws.set_mode(ws.MODE_FULL, [738561])

def on_close(ws, code, reason):
    ws.stop()  # no reconnection after this

kws.on_ticks = on_ticks
kws.on_connect = on_connect
kws.on_close = on_close
kws.connect()
```

--------------------------------

### ltp usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-market-data.md

Fetches last traded price for NFO:NIFTY25APRFUT and prints the last_price.

```python
ltps = kite.ltp("NFO:NIFTY25APRFUT")
print(ltps["NFO:NIFTY25APRFUT"]["last_price"])
```

--------------------------------

### order_margins usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-gtt-margins.md

Example call to order_margins with a single order dict. The order dict uses the place_order param shape. Prints the required margin for the first order.

```python
margins = kite.order_margins([{
    "exchange": "NSE",
    "tradingsymbol": "INFY",
    "transaction_type": "BUY",
    "variety": "regular",
    "product": "MIS",
    "order_type": "MARKET",
    "quantity": 2,
}])
print(margins[0]["required"])
```

--------------------------------

### KiteTicker initialization and connect with proxy

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/configuration.md

Instantiate KiteTicker with custom reconnection and timeout settings, then connect with a proxy and threaded mode. The example uses placeholder credentials and a proxy host/port.

```python
from kiteconnect import KiteTicker

kws = KiteTicker(
    api_key="your_api_key",
    access_token="your_access_token",
    debug=False,
    reconnect=True,
    reconnect_max_tries=100,
    reconnect_max_delay=30,
    connect_timeout=20,
)
kws.connect(threaded=True, proxy={"host": "proxy.local", "port": 8080})
```

--------------------------------

### get_virtual_contract_note usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-gtt-margins.md

Example call to get_virtual_contract_note with a single order dict. The order dict includes order_id, exchange, tradingsymbol, transaction_type, variety, product, order_type, quantity, and average_price.

```python
charges = kite.get_virtual_contract_note([{
    "order_id": "111111111",
    "exchange": "NSE",
    "tradingsymbol": "SBIN",
    "transaction_type": "BUY",
    "variety": "regular",
    "product": "CNC",
    "order_type": "MARKET",
    "quantity": 1,
    "average_price": 560,
}])
```

--------------------------------

### GET /orders

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves a list of orders.

```APIDOC
## GET /orders

### Description
Retrieves a list of orders.

### Method
GET

### Endpoint
/orders

### Response
#### Success Response (200)
- **data** (array) - List of order dicts.
```

--------------------------------

### ohlc usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-market-data.md

Fetches OHLC data for NSE:INFY and prints the last_price from the ohlc dict.

```python
data = kite.ohlc("NSE:INFY")
print(data["NSE:INFY"]["ohlc"]["last_price"])
```

--------------------------------

### connect usage examples

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/ticker.md

Shows two ways to call connect: blocking (default) and threaded. The threaded version keeps the main thread free, e.g., for a web server.

```python
kws.connect()                    # blocking — callbacks drive everything
# or
kws.connect(threaded=True)       # main thread stays free (e.g. a web server)
```

--------------------------------

### GET /mf/sips

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves a list of systematic investment plans (SIPs).

```APIDOC
## GET /mf/sips

### Description
Retrieves a list of systematic investment plans (SIPs).

### Method
GET

### Endpoint
/mf/sips

### Response
#### Success Response (200)
- **data** (list) - List of SIP dicts

#### Response Example
[]
```

--------------------------------

### historical_data usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-market-data.md

Fetches 5-minute candles for instrument token 738561 from 2024-01-01 to 2024-02-01 with continuous=False and oi=True. Iterates and prints date, OHLC, and volume.

```python
candles = kite.historical_data(
    instrument_token=738561,
    from_date=datetime.datetime(2024, 1, 1),
    to_date=datetime.datetime(2024, 2, 1),
    interval="5minute",
    continuous=False,
    oi=True,
)
for c in candles:
    print(c["date"], c["open"], c["high"], c["low"], c["close"], c.get("volume"))
```

--------------------------------

### GET /portfolio/positions

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves the user's portfolio positions, including both day and net positions.

```APIDOC
## GET /portfolio/positions

### Description
Retrieves the user's portfolio positions, including both day and net positions.

### Method
GET

### Endpoint
/portfolio/positions

### Response
#### Success Response (200)
- **day** (list) - List of day positions
- **net** (list) - List of net positions

#### Response Example
{
  "day": [],
  "net": []
}
```

--------------------------------

### place_mf_sip method signature

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-mutual-funds.md

Places a new mutual fund SIP. Requires tradingsymbol, amount, instalments, and frequency. Optional parameters include initial_amount, instalment_day, and tag. Returns a dict containing the SIP ID.

```python
def place_mf_sip(self,
                 tradingsymbol,
                 amount,
                 instalments,
                 frequency,
                 initial_amount=None,
                 instalment_day=None,
                 tag=None):
```

--------------------------------

### place_autoslice_order usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-orders.md

Places an autoslice order for 100,000 NIFTY futures. The response contains the parent order_id and a children list; each child is either a placed order or an error payload.

```python
response = kite.place_autoslice_order(
    variety=kite.VARIETY_REGULAR,
    exchange=kite.EXCHANGE_NFO,
    tradingsymbol="NIFTY25APRFUT",
    transaction_type=kite.TRANSACTION_TYPE_BUY,
    quantity=100000,
    product=kite.PRODUCT_MIS,
    order_type=kite.ORDER_TYPE_MARKET,
)

parent_order_id = response["order_id"]
for child in response.get("children", []):
    if "order_id" in child:
        print("child placed:", child["order_id"])
    else:
        print("child failed:", child["error"])
```

--------------------------------

### Filter buyable mutual fund instruments

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-mutual-funds.md

Example usage of mf_instruments to filter instruments where purchase_allowed is True and print the count of buyable instruments.

```python
instruments = kite.mf_instruments()
buyable = [i for i in instruments if i["purchase_allowed"]]
print(len(buyable))
```

--------------------------------

### GET /instruments/historical/{instrument_token}/{interval}

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves historical candle data for a given instrument and interval. The response is a list of candles formatted by `_format_historical`.

```APIDOC
## GET /instruments/historical/{instrument_token}/{interval}

### Description
Retrieves historical candle data for a given instrument and interval. The response is a list of candles formatted by `_format_historical`.

### Method
GET

### Endpoint
/instruments/historical/{instrument_token}/{interval}

### Parameters
#### Path Parameters
- **instrument_token** (string) - Required - The instrument token.
- **interval** (string) - Required - The candle interval (e.g., minute, day).

#### Query Parameters
- **from** (string) - Required - Start date/time.
- **to** (string) - Required - End date/time.
- **interval** (string) - Required - The candle interval (duplicate of path parameter).
- **continuous** (integer) - Optional - 1 for continuous data, 0 otherwise.
- **oi** (integer) - Optional - 1 to include open interest, 0 otherwise.

### Response
#### Success Response (200)
- **candle list** - List of candles via `_format_historical`.

#### Response Example
List of candle arrays.
```

--------------------------------

### quote usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-market-data.md

Fetches quotes for NSE:INFY and NSE:TCS. Shows both positional and list argument forms. Prints the last_price for NSE:INFY.

```python
quotes = kite.quote("NSE:INFY", "NSE:TCS")
# or: kite.quote(["NSE:INFY", "NSE:TCS"])
print(quotes["NSE:INFY"]["last_price"])
```

--------------------------------

### Run unit tests with setup.py

Source: https://github.com/zerodha/pykiteconnect/blob/master/README.md

Runs the unit test suite using the setup.py test command.

```sh
python setup.py test
```

--------------------------------

### delete_gtt usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-gtt-margins.md

Example of deleting a GTT by passing the trigger_id from a previously created GTT object.

```python
kite.delete_gtt(gtt["trigger_id"])
```

--------------------------------

### basket_order_margins usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-gtt-margins.md

Example call to basket_order_margins with two orders and mode='compact'. The compact mode returns only the total margins.

```python
amount = kite.basket_order_margins(
    [
        {"exchange": "NFO", "tradingsymbol": "NIFTY21JUN15400PE",
         "transaction_type": "BUY", "variety": "regular", "product": "MIS",
         "order_type": "MARKET", "quantity": 75},
        {"exchange": "NFO", "tradingsymbol": "NIFTY21JUN14450PE",
         "transaction_type": "SELL", "variety": "regular", "product": "MIS",
         "order_type": "MARKET", "quantity": 150},
    ],
    mode="compact",
)
```

--------------------------------

### KiteConnect(api_key, access_token=None, root=None, debug=False, timeout=None, proxies=None, pool=None, disable_ssl=False)

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/configuration.md

Initializes the KiteConnect client with the provided configuration. This constructor sets up the API session with authentication credentials and network options for subsequent API calls.

```APIDOC
## KiteConnect(api_key, access_token=None, root=None, debug=False, timeout=None, proxies=None, pool=None, disable_ssl=False)

### Description
Initializes the KiteConnect client with the provided configuration. This constructor sets up the API session with authentication credentials and network options for subsequent API calls.

### Method
Constructor

### Parameters
#### Constructor Parameters
- **api_key** (str) - Required - API key issued to you
- **access_token** (str) - Optional - Token obtained after the login flow; can also be set later via set_access_token()
- **root** (str) - Optional - API endpoint root; override for non-default endpoints. Default: "https://api.kite.trade"
- **debug** (bool) - Optional - Logs requests and responses via the logging module (log.debug). Default: False
- **timeout** (float) - Optional - Max seconds to wait for a request before it fails. Default: 7 seconds
- **proxies** (dict) - Optional - requests proxy settings; forwarded as proxies= to every request. Default: {}
- **pool** (dict) - Optional - Keyword args for requests.adapters.HTTPAdapter; when given, mounts the adapter on https:// of the internal session. Default: None
- **disable_ssl** (bool) - Optional - Disables SSL verification (verify=False); intended for custom non-SSL root URLs. Default: False

### Request Example
```python
from kiteconnect import KiteConnect

kite = KiteConnect(
    api_key="your_api_key",
    access_token="your_access_token",
    root="https://api.kite.trade",
    debug=True,
    timeout=10,
    proxies={"https": "http://proxy.local:8080"},
    pool={"pool_connections": 10, "pool_maxsize": 10, "max_retries": 3},
    disable_ssl=False,
)
```

### Response
#### Success Response
Returns a KiteConnect instance configured with the provided parameters.
```

--------------------------------

### Create KiteConnect client with full options

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/configuration.md

Instantiate the KiteConnect client with all optional parameters. The access_token can be omitted and set later via set_access_token(). The root defaults to https://api.kite.trade; override it for non-default endpoints. debug=True logs requests and responses via the logging module, timeout defaults to 7 seconds, and disable_ssl=True sets verify=False for custom non-SSL root URLs.

```python
from kiteconnect import KiteConnect

kite = KiteConnect(
    api_key="your_api_key",
    access_token="your_access_token",
    root="https://api.kite.trade",
    debug=True,
    timeout=10,
    proxies={"https": "http://proxy.local:8080"},
    pool={"pool_connections": 10, "pool_maxsize": 10, "max_retries": 3},
    disable_ssl=False,
)
```

--------------------------------

### KiteConnect API usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/README.md

Initializes KiteConnect with an API key, generates a session using a request token, and sets the access token. Places an equity order with specified parameters, fetches all orders and instruments, places and cancels mutual fund orders, and retrieves mutual fund instruments. Requires a valid API key, request token, and API secret.

```python
import logging
from kiteconnect import KiteConnect

logging.basicConfig(level=logging.DEBUG)

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")
kite.set_access_token(data["access_token"])

# Place an order
try:
    order_id = kite.place_order(tradingsymbol="INFY",
                                exchange=kite.EXCHANGE_NSE,
                                transaction_type=kite.TRANSACTION_TYPE_BUY,
                                quantity=1,
                                variety=kite.VARIETY_AMO,
                                order_type=kite.ORDER_TYPE_MARKET,
                                product=kite.PRODUCT_CNC,
                                validity=kite.VALIDITY_DAY)

    logging.info("Order placed. ID is: {}".format(order_id))
except Exception as e:
    logging.info("Order placement failed: {}".format(e.message))

# Fetch all orders
kite.orders()

# Get instruments
kite.instruments()

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

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

# Get mutual fund instruments
kite.mf_instruments()
```

--------------------------------

### GET /trades

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves a list of trades.

```APIDOC
## GET /trades

### Description
Retrieves a list of trades.

### Method
GET

### Endpoint
/trades

### Response
#### Success Response (200)
- **data** (array) - List of trade dicts.
```

--------------------------------

### GET /user/margins

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves margins for all segments.

```APIDOC
## GET /user/margins

### Description
Retrieves margins for all segments.

### Method
GET

### Endpoint
/user/margins

### Response
#### Success Response (200)
- **data** (object) - Margins for all segments.
```

--------------------------------

### connect method signature

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/ticker.md

Establishes the WebSocket connection and runs the Twisted reactor. Blocking by default; use threaded=True to run in a daemon thread. Sends header X-Kite-Version: 3 and the library User-Agent.

```python
def connect(self, threaded=False, disable_ssl_verification=False, proxy=None):
```

--------------------------------

### GET /user/profile

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves the user's profile.

```APIDOC
## GET /user/profile

### Description
Retrieves the user's profile.

### Method
GET

### Endpoint
/user/profile

### Response
#### Success Response (200)
- **data** (object) - User profile.
```

--------------------------------

### GET /mf/sips/{sip_id}

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves details of a specific SIP.

```APIDOC
## GET /mf/sips/{sip_id}

### Description
Retrieves details of a specific SIP.

### Method
GET

### Endpoint
/mf/sips/{sip_id}

### Parameters
#### Path Parameters
- **sip_id** (string) - Required - The ID of the SIP

### Response
#### Success Response (200)
- **data** (dict) - SIP dict

#### Response Example
{}
```

--------------------------------

### GET /mf/orders

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves a list of mutual fund orders.

```APIDOC
## GET /mf/orders

### Description
Retrieves a list of mutual fund orders.

### Method
GET

### Endpoint
/mf/orders

### Response
#### Success Response (200)
- **data** (list) - List of MF order dicts

#### Response Example
[]
```

--------------------------------

### GET /portfolio/holdings

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves the user's portfolio holdings.

```APIDOC
## GET /portfolio/holdings

### Description
Retrieves the user's portfolio holdings.

### Method
GET

### Endpoint
/portfolio/holdings

### Response
#### Success Response (200)
- **data** (list) - List of holding dicts

#### Response Example
[]
```

--------------------------------

### GET /orders/{order_id}

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves information for a specific order.

```APIDOC
## GET /orders/{order_id}

### Description
Retrieves information for a specific order.

### Method
GET

### Endpoint
/orders/{order_id}

### Parameters
#### Path Parameters
- **order_id** (string) - Required - The order ID.

### Response
#### Success Response (200)
- **data** (object) - Order dict.
```

--------------------------------

### connect(threaded=False, disable_ssl_verification=False, proxy=None)

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/configuration.md

Establishes the WebSocket connection with optional threading, SSL verification disabling, and proxy configuration. This method is part of the KiteTicker client.

```APIDOC
## connect(threaded=False, disable_ssl_verification=False, proxy=None)

### Description
Connects to the WebSocket endpoint with per-connection options. Allows threaded operation, disabling SSL verification, and setting a proxy.

### Method
connect

### Parameters
- **threaded** (bool) - Optional - Default: False - If True, runs the connection in a separate thread.
- **disable_ssl_verification** (bool) - Optional - Default: False - If True, disables SSL certificate verification.
- **proxy** (dict) - Optional - Default: None - Proxy configuration, e.g., {"host": "proxy.local", "port": 8080}.

### Example
```python
kws.connect(threaded=True, proxy={"host": "proxy.local", "port": 8080})
```

### Source
ticker.py (see api-reference/ticker.md)
```

--------------------------------

### GET /user/margins/{segment}

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves margins for a specific segment.

```APIDOC
## GET /user/margins/{segment}

### Description
Retrieves margins for a specific segment.

### Method
GET

### Endpoint
/user/margins/{segment}

### Parameters
#### Path Parameters
- **segment** (string) - Required - The segment (equity or commodity).

### Response
#### Success Response (200)
- **data** (object) - Margins for the segment.
```

--------------------------------

### GET /mf/holdings

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves the user's mutual fund holdings.

```APIDOC
## GET /mf/holdings

### Description
Retrieves the user's mutual fund holdings.

### Method
GET

### Endpoint
/mf/holdings

### Response
#### Success Response (200)
- **data** (list) - List of holding dicts

#### Response Example
[]
```

--------------------------------

### on_open

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/ticker.md

Callback invoked when the opening handshake is completed. Receives the KiteTicker instance.

```APIDOC
## on_open

### Description
Callback invoked when the WebSocket opening handshake is completed.

### Signature
`fn(ws)`

### Parameters
- **ws** (KiteTicker) - The KiteTicker instance.

### Trigger
Opening handshake completed.
```

--------------------------------

### on_connect

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/ticker.md

Callback invoked upon a successful connection to the server. Receives the KiteTicker instance and the server response.

```APIDOC
## on_connect

### Description
Callback invoked when the WebSocket connection is successfully established. The response from the server is passed as the second argument.

### Signature
`fn(ws, response)`

### Parameters
- **ws** (KiteTicker) - The KiteTicker instance.
- **response** (object) - The response received from the server upon connection.

### Trigger
Successful connection (response from server).
```

--------------------------------

### GET /orders/{order_id}/trades

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves trades for a specific order.

```APIDOC
## GET /orders/{order_id}/trades

### Description
Retrieves trades for a specific order.

### Method
GET

### Endpoint
/orders/{order_id}/trades

### Parameters
#### Path Parameters
- **order_id** (string) - Required - The order ID.

### Response
#### Success Response (200)
- **data** (array) - List of trade dicts.
```

--------------------------------

### Version metadata in kiteconnect/__version__.py

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/package.md

Package metadata variables defined in kiteconnect/__version__.py. Consumed by setup.py for distribution metadata.

```python
__title__ = "kiteconnect"
__description__ = "The official Python client for the Kite Connect trading API"
__url__ = "https://kite.trade"
__download_url__ = "https://github.com/zerodhatech/pykiteconnect"
__version__ = "5.2.2"
__author__ = "Zerodha Technology Pvt. Ltd. (India)"
__author_email__ = "talk@zerodha.tech"
__license__ = "MIT"
```

--------------------------------

### cancel_order usage example

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-orders.md

Cancels an order by its order_id and returns the cancelled order_id.

```python
cancelled_id = kite.cancel_order(kite.VARIETY_REGULAR, order_id)
```

--------------------------------

### connect

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/ticker.md

Establishes the WebSocket connection and runs the Twisted reactor. By default it blocks; set threaded=True to run in a daemon thread.

```APIDOC
## connect

### Description
Establishes the WebSocket connection and runs the Twisted reactor. By default it blocks; set threaded=True to run in a daemon thread.

### Method
connect

### Signature
```python
def connect(self, threaded=False, disable_ssl_verification=False, proxy=None):
```

### Parameters
- **threaded** (bool) - Optional - Default: `False` - Run the reactor in a daemon thread; signals are suppressed in the thread (`installSignalHandlers=False`)
- **disable_ssl_verification** (bool) - Optional - Default: `False` - Skip building the SSL `ClientContextFactory`
- **proxy** (dict) - Optional - Default: `None` - Proxy settings, dict with `host` and `port` keys

### Request Example
```python
kws.connect()                    # blocking — callbacks drive everything
# or
kws.connect(threaded=True)       # main thread stays free (e.g. a web server)
```

```python
kws.connect(threaded=True, disable_ssl_verification=False, proxy={"host": "proxy.local", "port": 8080})
```

### Response
No return value documented.
```

--------------------------------

### GET /gtt/triggers

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves all GTT triggers. The response is a list of GTT dictionaries.

```APIDOC
## GET /gtt/triggers

### Description
Retrieves all GTT (Good Till Triggered) triggers. The response is a list of GTT dictionaries.

### Method
GET

### Endpoint
/gtt/triggers

### Parameters
No parameters.

### Response
#### Success Response (200)
- **list** - List of GTT dicts.

#### Response Example
[
  {
    "trigger_id": 12345
  }
]
```

--------------------------------

### place_order method signature

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/connect-orders.md

Defines the place_order method with all parameters. None parameters are stripped before POST. market_protection accepts -1 (automatic) or 0 < value <= 100 (percentage); algo_id optionally associates an algo ID.

```python
def place_order(self,
                variety,
                exchange,
                tradingsymbol,
                transaction_type,
                quantity,
                product,
                order_type,
                price=None,
                validity=None,
                validity_ttl=None,
                disclosed_quantity=None,
                trigger_price=None,
                iceberg_legs=None,
                iceberg_quantity=None,
                auction_number=None,
                algo_id=None,
                tag=None,
                market_protection=None):
```

--------------------------------

### GET /mf/orders/{order_id}

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves details of a specific mutual fund order.

```APIDOC
## GET /mf/orders/{order_id}

### Description
Retrieves details of a specific mutual fund order.

### Method
GET

### Endpoint
/mf/orders/{order_id}

### Parameters
#### Path Parameters
- **order_id** (string) - Required - The ID of the mutual fund order

### Response
#### Success Response (200)
- **data** (dict) - MF order dict

#### Response Example
{}
```

--------------------------------

### Public exports in kiteconnect/__init__.py

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/package.md

Defines the public exports of the kiteconnect package. Importing from kiteconnect exposes KiteConnect, KiteTicker, and exceptions.

```python
__all__ = ["KiteConnect", "KiteTicker", "exceptions"]
```

--------------------------------

### GET /portfolio/holdings/auctions

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves a list of auction instruments for the user's holdings.

```APIDOC
## GET /portfolio/holdings/auctions

### Description
Retrieves a list of auction instruments for the user's holdings.

### Method
GET

### Endpoint
/portfolio/holdings/auctions

### Response
#### Success Response (200)
- **data** (list) - List of auction instrument dicts

#### Response Example
[]
```

--------------------------------

### subscribe and set_mode in on_connect

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/api-reference/ticker.md

Defines an on_connect callback that subscribes to tokens and sets mode to FULL for one token, then assigns it to kws.on_connect.

```python
def on_connect(ws, response):
    ws.subscribe([738561, 5633])
    ws.set_mode(ws.MODE_FULL, [738561])

kws.on_connect = on_connect
```

--------------------------------

### GET /gtt/triggers/{trigger_id}

Source: https://github.com/zerodha/pykiteconnect/blob/master/_autodocs/endpoints.md

Retrieves a specific GTT trigger by its ID. The response is a GTT dictionary.

```APIDOC
## GET /gtt/triggers/{trigger_id}

### Description
Retrieves a specific GTT trigger by its ID. The response is a GTT dictionary.

### Method
GET

### Endpoint
/gtt/triggers/{trigger_id}

### Parameters
#### Path Parameters
- **trigger_id** (string) - Required - The ID of the GTT trigger.

### Response
#### Success Response (200)
- **GTT dict** - The GTT trigger details.

#### Response Example
{
  "trigger_id": 12345,
  "condition": "...",
  "orders": "..."
}
```
Tokens:
Raw