Kite Connect Java Client

To use the SDK, initialize KiteConnect with your apiKey, set your userId, and obtain a login URL. After the user authenticates via the login URL, use the resulting request_token and your api_secret to generate a session. Once the session is generated, set the accessToken and publicToken on the KiteConnect instance to authorize subsequent API calls.

// Initialize Kiteconnect using apiKey.
KiteConnect kiteSdk = new KiteConnect("your_apiKey");

// Set userId.
kiteSdk.setUserId("your_userId");

// Get login url. Use this url in webview to login user.
String url = kiteSdk.getLoginUrl();

// Get accessToken using request_token and api_secret
User user = kiteSdk.generateSession("request_token", "your_apiSecret");

// Set request token and public token obtained from login process.
kiteSdk.setAccessToken(user.accessToken);
kiteSdk.setPublicToken(user.publicToken);

// Set session expiry callback.
kiteSdk.setSessionExpiryHook(new SessionExpiryHook() {
    @Override
    public void sessionExpired() {
        System.out.println("session expired");                    
    }
});

Use KiteTicker to establish a WebSocket connection for real-time market data. You must provide the accessToken and apiKey. The workflow involves setting up listeners for connection status, order updates, and incoming ticks, then calling connect().

Key Lifecycle Methods:

• connect(): Starts the WebSocket connection.
• disconnect(): Closes the connection.
• subscribe(tokens): Subscribes to specific tokens.
• unsubscribe(tokens): Unsubscribes from tokens.
• setMode(tokens, mode): Sets the data granularity for specific tokens.

Reconnection Settings:

• setTryReconnection(true): Enables automatic reconnection.
• setMaximumRetries(int): Sets the max number of retry attempts.
• setMaximumRetryInterval(int): Sets the max interval between retries in seconds.

KiteTicker tickerProvider = new KiteTicker(kiteConnect.getAccessToken(), kiteConnect.getApiKey());

tickerProvider.setOnConnectedListener(new OnConnect() {
    @Override
    public void onConnected() {
        tickerProvider.subscribe(tokens);
        tickerProvider.setMode(tokens, KiteTicker.modeFull);
    }
});

tickerProvider.setOnTickerArrivalListener(new OnTicks() {
    @Override
    public void onTicks(ArrayList<Tick> ticks) {
        if(!ticks.isEmpty()) {
            System.out.println("Last price: " + ticks.get(0).getLastTradedPrice());
        }
    }
});

tickerProvider.setTryReconnection(true);

tickerProvider.connect();

Major migration guide for moving from version 2 to version 3 of the Java client. Key changes include:

Package Name Changes:

• com.rainmatter.kiteconnect $\rightarrow$ com.zerodhatech.kiteconnect
• com.rainmatter.models $\rightarrow$ com.zerodhatech.models
• (Other com.rainmatter.* packages also moved to com.zerodhatech.kiteconnect.*)

Method Name Changes:

• requestAccessToken $\rightarrow$ generateSession
• getOrder $\rightarrow$ getOrderHistory
• getTrades(order_id) $\rightarrow$ getOrderTrades(order_id)
• getMfOrders $\rightarrow$ getMFOrders
• modifySip $\rightarrow$ modifySIP

Model and Type Changes:

• Many timestamp fields (e.g., orderTimestamp, exchangeTimestamp, created, loginTime) changed from String to Date type.
• UserModel was renamed to User.
• Funds model Margins was renamed to Margin.
• User model: product $\rightarrow$ products, exchange $\rightarrow$ exchanges, orderType $\rightarrow$ orderTypes.
• Instrument model: expiry is now Date type.

Bracket Order Parameters:

• squareoff_value $\rightarrow$ squareoff
• stoploss_value $\rightarrow$ stoploss

To place an order, populate an OrderParams object with required fields such as tradingsymbol, exchange, transactionType, orderType, quantity, product, price, and validity. Use the placeOrder method, specifying the order variety (e.g., Constants.VARIETY_REGULAR). Note that a successful call implies the order was placed, not necessarily executed. If the call fails, a KiteException will be thrown.

OrderParams orderParams = new OrderParams();
orderParams.quantity = 1;
orderParams.orderType = Constants.ORDER_TYPE_LIMIT;
orderParams.tradingsymbol = "ASHOKLEY";
orderParams.product = Constants.PRODUCT_CNC;
orderParams.exchange = Constants.EXCHANGE_NSE;
orderParams.transactionType = Constants.TRANSACTION_TYPE_BUY;
orderParams.validity = Constants.VALIDITY_DAY;
orderParams.price = 122.2;
orderParams.triggerPrice = 0.0;
orderParams.tag = "myTag"; // Optional: max 8 alphanumeric chars

Order order = kiteConnect.placeOrder(orderParams, Constants.VARIETY_REGULAR);
System.out.println(order.orderId);