# zerodha/javakiteconnect architecture

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

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

## Overview

##### Main Components

a) Core Components:
- KiteConnect Client (Central Component)
- WebSocket Ticker Component
- HTTP Request/Response Handler
- Model Layer
- Exception Handler

b) External Systems:
- Kite Connect REST API Server
- Kite Connect WebSocket Server
- Client Applications

##### Component Relationships

**[Client Applications]**
- ↕
**[KiteConnect SDK]**

- [KiteConnect Core]---→[HTTP Layer]---→[Kite REST API]
- ↓
- [Models]
- ↓
- [KiteTicker]--------→[WebSocket]----→[Kite WebSocket Server]

- [Exception Handler]

##### Detailed Component Breakdown

a) KiteConnect Core (Central Component):
- Main class (KiteConnect.java)
- Routes.java for API endpoints
- Connection to authentication system

b) HTTP Layer:
- KiteRequestHandler
- KiteResponseHandler
- SessionExpiryHook

c) Models Layer (Group together):
- Trading models (Order, Trade, Position)
- Market Data models (Quote, Tick, OHLC)
- User models (User, Profile)
- Financial models (Margin, Holding)

d) WebSocket Component:
- KiteTicker
- Event Listeners (OnConnect, OnDisconnect, OnTicks)
- Market Data Stream

e) Exception Handling:
- Hierarchy of exceptions
- To relevant components

##### Important Details

- Authentication flow
- Data flow directions
- WebSocket connection lifecycle
- Error handling paths
- Model relationships

##### Additional Elements

- Version information (3.4.0)
- Third-party dependencies (OkHttp, GSON, etc.)
- Async vs sync operations

##### Notes for Implementation

- Keep the main trading flow prominent
- Separation between REST and WebSocket
- Clear boundaries between SDK and external systems
- Important configuration points

- The SDK's role as a bridge between client applications and Kite's trading platform
- Clear separation of concerns between components
- The dual nature of communication (REST + WebSocket)
- Robust error handling throughout the system

This design should be implemented using a professional diagramming tool that supports UML or similar notation, ensuring that all relationships and dependencies are clearly visible while maintaining a clean, professional appearance.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client["Client Applications"]
        App[Client Applications]:::client
    end

    subgraph SDK["KiteConnect SDK v3.4.0"]
        subgraph Core["Core Components"]
            KiteConnect[KiteConnect Client]:::core
            Routes[API Routes]:::core
            Constants[Constants & Utils]:::core
        end

        subgraph HTTP["HTTP Layer"]
            RequestHandler[Request Handler]:::http
            ResponseHandler[Response Handler]:::http
            SessionHook[Session Expiry Hook]:::http
        end

        subgraph Models["Models Layer"]
            subgraph TradingModels["Trading Models"]
                Order[Order]:::model
                Trade[Trade]:::model
                Position[Position]:::model
            end

            subgraph MarketModels["Market Data Models"]
                Quote[Quote]:::model
                Tick[Tick]:::model
                OHLC[OHLC]:::model
            end

            subgraph UserModels["User Models"]
                User[User]:::model
                Profile[Profile]:::model
            end

            subgraph FinancialModels["Financial Models"]
                Margin[Margin]:::model
                Holding[Holding]:::model
            end
        end

        subgraph WebSocket["WebSocket Component"]
            KiteTicker[KiteTicker]:::websocket
            OnConnect[OnConnect]:::websocket
            OnDisconnect[OnDisconnect]:::websocket
            OnTicks[OnTicks]:::websocket
            OnError[OnError]:::websocket
            OnOrderUpdate[OnOrderUpdate]:::websocket
        end

        subgraph Exceptions["Exception Handler"]
            ExceptionHandler[Exception Handler]:::error
        end
    end

    subgraph External["External Systems"]
        KiteAPI[Kite Connect REST API]:::external
        KiteWS[Kite WebSocket Server]:::external
    end

    %% Relationships
    App --> KiteConnect
    KiteConnect --> Routes
    KiteConnect --> RequestHandler
    RequestHandler --> ResponseHandler
    ResponseHandler --> KiteAPI
    SessionHook --> RequestHandler

    KiteConnect --> KiteTicker
    KiteTicker --> OnConnect
    KiteTicker --> OnDisconnect
    KiteTicker --> OnTicks
    KiteTicker --> OnError
    KiteTicker --> OnOrderUpdate
    KiteTicker --> KiteWS

    KiteConnect --> ExceptionHandler
    KiteConnect --> Models

    %% Click events
    click KiteConnect "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/kiteconnect/KiteConnect.java"
    click Routes "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/kiteconnect/Routes.java"
    click Constants "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/kiteconnect/utils/Constants.java"
    click RequestHandler "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/kiteconnect/kitehttp/KiteRequestHandler.java"
    click ResponseHandler "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/kiteconnect/kitehttp/KiteResponseHandler.java"
    click SessionHook "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/kiteconnect/kitehttp/SessionExpiryHook.java"
    click ExceptionHandler "https://github.com/zerodha/javakiteconnect/tree/master/kiteconnect/src/com/zerodhatech/kiteconnect/kitehttp/exceptions/"
    click KiteTicker "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/ticker/KiteTicker.java"
    click OnConnect "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/ticker/OnConnect.java"
    click OnDisconnect "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/ticker/OnDisconnect.java"
    click OnTicks "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/ticker/OnTicks.java"
    click OnError "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/ticker/OnError.java"
    click OnOrderUpdate "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/ticker/OnOrderUpdate.java"
    click Order "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/models/Order.java"
    click Trade "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/models/Trade.java"
    click Position "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/models/Position.java"
    click Quote "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/models/Quote.java"
    click Tick "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/models/Tick.java"
    click OHLC "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/models/OHLC.java"
    click User "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/models/User.java"
    click Profile "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/models/Profile.java"
    click Margin "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/models/Margin.java"
    click Holding "https://github.com/zerodha/javakiteconnect/blob/master/kiteconnect/src/com/zerodhatech/models/Holding.java"

    %% Styling
    classDef client fill:#f9f,stroke:#333,stroke-width:2px
    classDef core fill:#9cf,stroke:#333,stroke-width:2px
    classDef http fill:#fc9,stroke:#333,stroke-width:2px
    classDef model fill:#ff9,stroke:#333,stroke-width:2px
    classDef websocket fill:#9fc,stroke:#333,stroke-width:2px
    classDef error fill:#f99,stroke:#333,stroke-width:2px
    classDef external fill:#ccc,stroke:#333,stroke-width:2px
```
