# zerodha/pykiteconnect architecture

> Architecture diagram of the GitHub repository zerodha/pykiteconnect, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/zerodha/pykiteconnect
- Repository: https://github.com/zerodha/pykiteconnect

## Overview

Kite Connect is a Python client for trading and market-data APIs. A typical workflow creates a KiteConnect client, completes the request-token login flow, stores the access token, and uses authenticated REST methods for trading or account data. KiteTicker provides a separate WebSocket workflow for live ticks and order updates, including subscriptions and automatic reconnection. The graph groups related REST capabilities implemented in the same facade. Connections among individual REST methods are based on README descriptions; unsampled implementation details are not inferred.

Main entry points: [`kiteconnect/connect.py`](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py) (KiteConnect facade), [`kiteconnect/ticker.py`](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/ticker.py) (KiteTicker client), [`kiteconnect/exceptions.py`](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/exceptions.py) (Client exceptions)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_rest["REST client"]
  node_kiteconnect["KiteConnect facade<br/>[connect.py]"]
  node_auth["Session authentication<br/>[connect.py]"]
  node_orders["Order management<br/>[connect.py]"]
  node_portfolio["Portfolio operations<br/>[connect.py]"]
  node_market["Market data<br/>[connect.py]"]
  node_mutualfunds["Mutual funds<br/>[connect.py]"]
  node_gtt["GTT orders<br/>[connect.py]"]
end

subgraph group_stream["WebSocket streaming"]
  node_ticker["KiteTicker client<br/>[ticker.py]"]
  node_protocol["WebSocket protocol<br/>[ticker.py]"]
end

subgraph group_errors["Error handling"]
  node_exceptions["Client exceptions<br/>[exceptions.py]"]
end

node_developer(("Client application"))
node_kiteapi["Kite Connect API"]
node_marketstream["Live market stream"]
node_callbacks(("Application callbacks"))

node_developer -->|"creates client"| node_kiteconnect
node_developer -->|"completes login"| node_auth
node_auth -->|"requests session"| node_kiteapi
node_developer -->|"places orders"| node_orders
node_developer -->|"manages portfolio"| node_portfolio
node_developer -->|"requests data"| node_market
node_developer -->|"manages funds"| node_mutualfunds
node_developer -->|"manages triggers"| node_gtt
node_kiteconnect -->|"exposes methods"| node_orders
node_kiteconnect -->|"exposes methods"| node_portfolio
node_kiteconnect -->|"exposes methods"| node_market
node_kiteconnect -->|"exposes methods"| node_mutualfunds
node_orders -->|"sends REST requests"| node_kiteapi
node_portfolio -->|"sends REST requests"| node_kiteapi
node_market -->|"sends REST requests"| node_kiteapi
node_mutualfunds -->|"sends REST requests"| node_kiteapi
node_gtt -->|"sends REST requests"| node_kiteapi
node_developer -->|"starts stream client"| node_ticker
node_ticker -->|"creates protocol"| node_protocol
node_protocol -->|"connects WebSocket"| node_marketstream
node_protocol -->|"delivers messages"| node_ticker
node_ticker -->|"invokes callbacks"| node_callbacks
node_kiteconnect -->|"raises API errors"| node_exceptions

click node_kiteconnect "https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py"
click node_auth "https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py"
click node_orders "https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py"
click node_portfolio "https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py"
click node_market "https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py"
click node_mutualfunds "https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py"
click node_gtt "https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py"
click node_ticker "https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/ticker.py"
click node_protocol "https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/ticker.py"
click node_exceptions "https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/exceptions.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_kiteconnect,node_auth,node_orders,node_portfolio,node_market,node_mutualfunds,node_gtt,node_developer toneBlue
class node_ticker,node_protocol toneAmber
class node_exceptions,node_kiteapi toneMint
class node_marketstream,node_callbacks toneIndigo
```

## Components

### REST client

- [KiteConnect facade](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py): `kiteconnect/connect.py`
- [Session authentication](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py): `kiteconnect/connect.py`
- [Order management](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py): `kiteconnect/connect.py`
- [Portfolio operations](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py): `kiteconnect/connect.py`
- [Market data](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py): `kiteconnect/connect.py`
- [Mutual funds](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py): `kiteconnect/connect.py`
- [GTT orders](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/connect.py): `kiteconnect/connect.py`

### WebSocket streaming

- [KiteTicker client](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/ticker.py): `kiteconnect/ticker.py`
- [WebSocket protocol](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/ticker.py): `kiteconnect/ticker.py`

### Error handling

- [Client exceptions](https://github.com/zerodha/pykiteconnect/blob/master/kiteconnect/exceptions.py): `kiteconnect/exceptions.py`

### Other components

- **Client application**
- **Kite Connect API**
- **Live market stream**
- **Application callbacks**

## Connections

- Client application → KiteConnect facade: creates client (evidence: `README.md`)
- Client application → Session authentication: completes login (evidence: `README.md`)
- Session authentication → Kite Connect API: requests session (evidence: `README.md`)
- Client application → Order management: places orders (evidence: `README.md`)
- Client application → Portfolio operations: manages portfolio (evidence: `README.md`)
- Client application → Market data: requests data (evidence: `README.md`)
- Client application → Mutual funds: manages funds (evidence: `README.md`)
- Client application → GTT orders: manages triggers (evidence: `kiteconnect/connect.py`)
- KiteConnect facade → Order management: exposes methods (evidence: `README.md`)
- KiteConnect facade → Portfolio operations: exposes methods (evidence: `README.md`)
- KiteConnect facade → Market data: exposes methods (evidence: `README.md`)
- KiteConnect facade → Mutual funds: exposes methods (evidence: `README.md`)
- Order management → Kite Connect API: sends REST requests (evidence: `kiteconnect/connect.py`)
- Portfolio operations → Kite Connect API: sends REST requests (evidence: `README.md`)
- Market data → Kite Connect API: sends REST requests (evidence: `kiteconnect/connect.py`)
- Mutual funds → Kite Connect API: sends REST requests (evidence: `kiteconnect/connect.py`)
- GTT orders → Kite Connect API: sends REST requests (evidence: `kiteconnect/connect.py`)
- Client application → KiteTicker client: starts stream client (evidence: `README.md`)
- KiteTicker client → WebSocket protocol: creates protocol (evidence: `kiteconnect/ticker.py`)
- WebSocket protocol → Live market stream: connects WebSocket (evidence: `README.md`)
- WebSocket protocol → KiteTicker client: delivers messages (evidence: `kiteconnect/ticker.py`)
- KiteTicker client → Application callbacks: invokes callbacks (evidence: `README.md`)
- KiteConnect facade → Client exceptions: raises API errors (evidence: `kiteconnect/connect.py`)
