com.zerodhatech.kiteconnect

Class KiteConnect

java.lang.Object

com.zerodhatech.kiteconnect.KiteConnect

All Implemented Interfaces:

AutoCloseable

public class KiteConnect
extends Object
implements AutoCloseable

Offers all the functionality like placing order, fetch margins, orderbook, positions, fetch market snap quote.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ENABLE_LOGGING
static SessionExpiryHook	sessionExpiryHook

Constructor Summary

Constructors

Constructor and Description
KiteConnect(String apiKey) Initializes KiteSDK with the api key provided for your app.
KiteConnect(String apiKey, boolean enableDebugLog) Initializes KiteSDK with the api key provided for your app.
KiteConnect(String apiKey, Proxy userProxy, boolean enableDebugLog) Initializes KiteSDK with the api key provided for your app.

Method Summary

Modifier and Type	Method and Description
GTT	cancelGTT(int gttId) Cancel GTT.
boolean	cancelMFOrder(String orderId) If cancel is successful then api will respond as 200 and send back true else it will be sent back to user as KiteException.
boolean	cancelMFSIP(String sipId) Cancel a mutualfunds sip.
Order	cancelOrder(String orderId, String variety) Cancels an order.
Order	cancelOrder(String orderId, String parentOrderId, String variety) Cancel/exit special orders like BO, CO
void	close() Releases any network resources associated with this client.
org.json.JSONObject	convertPosition(String tradingSymbol, String exchange, String transactionType, String positionType, String oldProduct, String newProduct, int quantity) Modifies an open position's product type.
User	generateSession(String requestToken, String apiSecret) Do the token exchange with the `request_token` obtained after the login flow, and retrieve the `access_token` required for all subsequent requests.
String	getAccessToken() Returns accessToken.
String	getApiKey() Returns apiKey of the App.
List<AuctionInstrument>	getAuctionInstruments() Fetches collection of auction instruments available for bidding.
CombinedMarginData	getCombinedMarginCalculation(List<MarginCalculationParams> params, boolean considerPositions, boolean compactMode) Get margins required data for multiple instruments before placing an order, this can be used to check the margin required for taking hedged positions.
GTT	getGTT(int gttId) Fetch details of a GTT.
List<GTT>	getGTTs() Fetches list of gtt existing in an account.
HistoricalData	getHistoricalData(Date from, Date to, String token, String interval, boolean continuous, boolean oi) Retrieves historical data for an instrument.
List<Holding>	getHoldings() Retrieves the list of holdings.
List<Instrument>	getInstruments() Retrieves list of market instruments available to trade.
List<Instrument>	getInstruments(String exchange) Retrieves list of market instruments available to trade for an exchange Response is array for objects.
String	getLoginURL() Retrieves login url
Map<String,LTPQuote>	getLTP(String[] instruments) Retrieves last price.
List<MarginCalculationData>	getMarginCalculation(List<MarginCalculationParams> params) Get margins required data before placing an order.
Map<String,Margin>	getMargins() Gets account balance and cash margin details for a equity and commodity.
Margin	getMargins(String segment) Gets account balance and cash margin details for a particular segment.
List<MFHolding>	getMFHoldings() Retrieve all the mutualfunds holdings.
List<MFInstrument>	getMFInstruments() Retrieves mutualfunds instruments.
MFOrder	getMFOrder(String orderId) Retrieves individual mutualfunds order.
List<MFOrder>	getMFOrders() Retrieves all mutualfunds orders.
MFSIP	getMFSIP(String sipId) Retrieve an individual sip.
List<MFSIP>	getMFSIPs() Retrieve all mutualfunds sip.
Map<String,OHLCQuote>	getOHLC(String[] instruments) Retrieves OHLC and last price.
List<Order>	getOrderHistory(String orderId) Returns list of different stages an order has gone through.
List<Order>	getOrders() Fetches collection of orders from the orderbook.
List<Trade>	getOrderTrades(String orderId) Retrieves list of trades executed of an order.
Map<String,List<Position>>	getPositions() Retrieves the list of positions.
Profile	getProfile() Get the profile details of the use.
String	getPublicToken() Returns publicToken.
Map<String,Quote>	getQuote(String[] instruments) Retrieves quote and market depth for an instrument
List<Trade>	getTrades() Retrieves list of trades executed.
String	getUserId() Returns userId.
List<ContractNote>	getVirtualContractNote(List<ContractNoteParams> params) A virtual contract provides detailed charges order-wise for brokerage, STT, stamp duty, exchange transaction charges, SEBI turnover charge, and GST.
org.json.JSONObject	invalidateAccessToken() Kills the session by invalidating the access token.
org.json.JSONObject	invalidateRefreshToken(String refreshToken) Kills the refresh token.
org.json.JSONObject	logout() Logs out user by invalidating the access token.
GTT	modifyGTT(int gttId, GTTParams gttParams) Modify a GTT.
boolean	modifyMFSIP(String frequency, int day, int instalments, double amount, String status, String sipId) Modify a mutualfunds sip.
Order	modifyOrder(String orderId, OrderParams orderParams, String variety) Modifies an open order.
GTT	placeGTT(GTTParams gttParams) Place a GTT.
MFOrder	placeMFOrder(String tradingsymbol, String transactionType, double amount, double quantity, String tag) Place a mutualfunds order.
MFSIP	placeMFSIP(String tradingsymbol, String frequency, int installmentDay, int instalments, int initialAmount, double amount) Place a mutualfunds sip.
OrderResponse	placeOrder(OrderParams orderParams, String variety) Places an order for the given variety.
TokenSet	renewAccessToken(String refreshToken, String apiSecret) Get a new access token using refresh token.
void	setAccessToken(String accessToken) Set the accessToken received after a successful authentication.
void	setPublicToken(String publicToken) Set publicToken.
void	setSessionExpiryHook(SessionExpiryHook hook) Registers callback for session error.
void	setUserId(String id) Set userId.
String	sha256Hex(String str) Hex encodes sha256 output for android support.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sessionExpiryHook

public static SessionExpiryHook sessionExpiryHook

ENABLE_LOGGING

public static boolean ENABLE_LOGGING

Constructor Detail

KiteConnect

public KiteConnect(String apiKey)

Initializes KiteSDK with the api key provided for your app.

Parameters:

apiKey - is the api key provided after creating new Kite Connect app on developers console.

KiteConnect

public KiteConnect(String apiKey,
                   boolean enableDebugLog)

Initializes KiteSDK with the api key provided for your app.

Parameters:

apiKey - is the api key provided after creating new Kite Connect app on developers console.

enableDebugLog - is a boolean to enable debug logs

KiteConnect

public KiteConnect(String apiKey,
                   Proxy userProxy,
                   boolean enableDebugLog)

Initializes KiteSDK with the api key provided for your app.

Parameters:

apiKey - is the api key provided after creating new Kite Connect app on developers console.

userProxy - is the user defined proxy. Can be used only if a user chose to use the proxy.

Method Detail

setSessionExpiryHook

public void setSessionExpiryHook(SessionExpiryHook hook)

Registers callback for session error.

Parameters:

hook - can be set to get callback when session is expired.

getApiKey

public String getApiKey()
                 throws NullPointerException

Returns apiKey of the App.

Returns:

String apiKey is returned.

Throws:

NullPointerException - if _apiKey is not found.

getAccessToken

public String getAccessToken()
                      throws NullPointerException

Returns accessToken.

Returns:

String access_token is returned.

Throws:

NullPointerException - if accessToken is null.

getUserId

public String getUserId()
                 throws NullPointerException

Returns userId.

Returns:

String userId is returned.

Throws:

NullPointerException - if userId is null.

setUserId

public void setUserId(String id)

Set userId.

Parameters:

id - is user_id.

getPublicToken

public String getPublicToken()
                      throws NullPointerException

Returns publicToken.

Returns:

String public token is returned.

Throws:

NullPointerException - if publicToken is null.

setAccessToken

public void setAccessToken(String accessToken)

Set the accessToken received after a successful authentication.

Parameters:

accessToken - is the access token received after sending request token and api secret.

setPublicToken

public void setPublicToken(String publicToken)

Set publicToken.

Parameters:

publicToken - is the public token received after sending request token and api secret.

close

public void close()

Releases any network resources associated with this client.

Specified by:

close in interface AutoCloseable

getLoginURL

public String getLoginURL()
                   throws NullPointerException

Retrieves login url

Returns:

String loginUrl is returned.

Throws:

NullPointerException

generateSession

public User generateSession(String requestToken,
                            String apiSecret)
                     throws KiteException,
                            org.json.JSONException,
                            IOException

Do the token exchange with the `request_token` obtained after the login flow, and retrieve the `access_token` required for all subsequent requests.

Parameters:

requestToken - received from login process.

apiSecret - which is unique for each aap.

Returns:

User is the user model which contains user and session details.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

renewAccessToken

public TokenSet renewAccessToken(String refreshToken,
                                 String apiSecret)
                          throws IOException,
                                 KiteException,
                                 org.json.JSONException

Get a new access token using refresh token.

Parameters:

refreshToken - is the refresh token obtained after generateSession.

apiSecret - is unique for each app.

Returns:

TokenSet contains user id, refresh token, api secret.

Throws:

IOException - is thrown when there is connection error.

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException

sha256Hex

public String sha256Hex(String str)

Hex encodes sha256 output for android support.

Parameters:

str - is the String that has to be encrypted.

Returns:

Hex encoded String.

getProfile

public Profile getProfile()
                   throws IOException,
                          KiteException,
                          org.json.JSONException

Get the profile details of the use.

Returns:

Profile is a POJO which contains profile related data.

Throws:

IOException - is thrown when there is connection error.

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException

getMargins

public Margin getMargins(String segment)
                  throws KiteException,
                         org.json.JSONException,
                         IOException

Gets account balance and cash margin details for a particular segment. Example for segment can be equity or commodity.

Parameters:

segment - can be equity or commodity.

Returns:

Margins object.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

getMargins

public Map<String,Margin> getMargins()
                              throws KiteException,
                                     org.json.JSONException,
                                     IOException

Gets account balance and cash margin details for a equity and commodity.

Returns:

Map of String and Margin is a map of commodity or equity string and funds data.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

getMarginCalculation

public List<MarginCalculationData> getMarginCalculation(List<MarginCalculationParams> params)
                                                 throws IOException,
                                                        KiteException,
                                                        org.json.JSONException

Get margins required data before placing an order.

Returns:

MarginCalculationData list contains the total, var, exposure, span and other components of the margin required.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

getCombinedMarginCalculation

public CombinedMarginData getCombinedMarginCalculation(List<MarginCalculationParams> params,
                                                       boolean considerPositions,
                                                       boolean compactMode)
                                                throws IOException,
                                                       KiteException,
                                                       org.json.JSONException

Get margins required data for multiple instruments before placing an order, this can be used to check the margin required for taking hedged positions.

Returns:

CombinedMarginData object, it contains the initial, final and margin calculation for each order.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

getVirtualContractNote

public List<ContractNote> getVirtualContractNote(List<ContractNoteParams> params)
                                          throws IOException,
                                                 KiteException,
                                                 org.json.JSONException

A virtual contract provides detailed charges order-wise for brokerage, STT, stamp duty, exchange transaction charges, SEBI turnover charge, and GST.

Returns:

ContractNote list contains the data and charges for all the orders passed as input.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

placeOrder

public OrderResponse placeOrder(OrderParams orderParams,
                                String variety)
                         throws KiteException,
                                org.json.JSONException,
                                IOException

Places an order for the given variety.

Parameters:

orderParams - order input payload. Populate the fields required for the order being placed, such as exchange, tradingsymbol, transactionType, quantity, product, orderType, validity, price, triggerPrice, disclosedQuantity, tag, and marketProtection. For Constants.VALIDITY_TTL, also set validityTTL. For Constants.VARIETY_ICEBERG, also set icebergLegs and icebergQuantity. For Constants.VARIETY_AUCTION, also set auctionNumber. Set autoslice to true to allow the order to be sliced automatically when applicable.

variety - order variety to place. Supported values include regular, amo, co, bo, iceberg, and auction, subject to API support.

Returns:

order placement response containing the parent orderId and, when applicable, sliced child order results.

Throws:

KiteException - if the Kite API returns a trading or request error.

org.json.JSONException - if the response cannot be parsed as JSON.

IOException - if a network or connection error occurs while placing the order.

modifyOrder

public Order modifyOrder(String orderId,
                         OrderParams orderParams,
                         String variety)
                  throws KiteException,
                         org.json.JSONException,
                         IOException

Modifies an open order.

Parameters:

orderParams - is Order params.

variety - variety="regular". Order variety can be bo, co, amo, regular.

orderId - order id of the order being modified.

Returns:

Order object contains only orderId.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

cancelOrder

public Order cancelOrder(String orderId,
                         String variety)
                  throws KiteException,
                         org.json.JSONException,
                         IOException

Cancels an order.

Parameters:

orderId - order id of the order to be cancelled.

variety - [variety="regular"]. Order variety can be bo, co, amo, regular.

Returns:

Order object contains only orderId.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

cancelOrder

public Order cancelOrder(String orderId,
                         String parentOrderId,
                         String variety)
                  throws KiteException,
                         IOException,
                         org.json.JSONException

Cancel/exit special orders like BO, CO

Parameters:

parentOrderId - order id of first leg.

orderId - order id of the order to be cancelled.

variety - [variety="regular"]. Order variety can be bo, co, amo, regular.

Returns:

Order object contains only orderId.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection error.

org.json.JSONException

getOrders

public List<Order> getOrders()
                      throws KiteException,
                             org.json.JSONException,
                             IOException

Fetches collection of orders from the orderbook.

Returns:

List of orders.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

getAuctionInstruments

public List<AuctionInstrument> getAuctionInstruments()
                                              throws KiteException,
                                                     org.json.JSONException,
                                                     IOException

Fetches collection of auction instruments available for bidding.

Returns:

List of Auction Instruments.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

getGTTs

public List<GTT> getGTTs()
                  throws KiteException,
                         IOException,
                         org.json.JSONException

Fetches list of gtt existing in an account.

Returns:

List of GTTs.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection error.

org.json.JSONException

getGTT

public GTT getGTT(int gttId)
           throws IOException,
                  KiteException,
                  org.json.JSONException

Fetch details of a GTT.

Parameters:

gttId - is the id of the GTT that needs to be fetched.

Returns:

GTT object which contains all the details.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection error.

org.json.JSONException - is thrown when there is exception while parsing response.

placeGTT

public GTT placeGTT(GTTParams gttParams)
             throws IOException,
                    KiteException,
                    org.json.JSONException

Place a GTT.

Parameters:

gttParams - is GTT param which container condition, type, order details. It can contain one or two orders.

Returns:

GTT object contains only gttId.

Throws:

IOException - is thrown when there is connection error.

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

modifyGTT

public GTT modifyGTT(int gttId,
                     GTTParams gttParams)
              throws IOException,
                     KiteException,
                     org.json.JSONException

Modify a GTT.

Parameters:

gttParams - is GTT param which container condition, type, order details. It can contain one or two orders.

gttId - is the id of the GTT to be modified.

Returns:

GTT object contains only gttId.

Throws:

IOException - is thrown when there is connection error.

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

cancelGTT

public GTT cancelGTT(int gttId)
              throws IOException,
                     KiteException,
                     org.json.JSONException

Cancel GTT.

Parameters:

gttId - order id of first leg.

Returns:

GTT object contains only gttId.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection error.

org.json.JSONException - is thrown when there is exception while parsing response.

getOrderHistory

public List<Order> getOrderHistory(String orderId)
                            throws KiteException,
                                   IOException,
                                   org.json.JSONException

Returns list of different stages an order has gone through.

Parameters:

orderId - is the order id which is obtained from orderbook.

Returns:

List of multiple stages an order has gone through in the system.

Throws:

KiteException - is thrown for all Kite trade related errors.

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection error.

org.json.JSONException

getTrades

public List<Trade> getTrades()
                      throws KiteException,
                             org.json.JSONException,
                             IOException

Retrieves list of trades executed.

Returns:

List of trades.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

getOrderTrades

public List<Trade> getOrderTrades(String orderId)
                           throws KiteException,
                                  org.json.JSONException,
                                  IOException

Retrieves list of trades executed of an order.

Parameters:

orderId - order if of the order whose trades are fetched.

Returns:

List of trades for the given order.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

getHoldings

public List<Holding> getHoldings()
                          throws KiteException,
                                 org.json.JSONException,
                                 IOException

Retrieves the list of holdings.

Returns:

List of holdings.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

getPositions

public Map<String,List<Position>> getPositions()
                                        throws KiteException,
                                               org.json.JSONException,
                                               IOException

Retrieves the list of positions.

Returns:

List of positions.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

convertPosition

public org.json.JSONObject convertPosition(String tradingSymbol,
                                           String exchange,
                                           String transactionType,
                                           String positionType,
                                           String oldProduct,
                                           String newProduct,
                                           int quantity)
                                    throws KiteException,
                                           org.json.JSONException,
                                           IOException

Modifies an open position's product type. Only an MIS, CNC, and NRML positions can be converted.

Parameters:

tradingSymbol - Tradingsymbol of the instrument (ex. RELIANCE, INFY).

exchange - Exchange in which instrument is listed (NSE, BSE, NFO, BFO, CDS, MCX).

transactionType - Transaction type (BUY or SELL).

positionType - day or overnight position

oldProduct - Product code (NRML, MIS, CNC).

newProduct - Product code (NRML, MIS, CNC).

quantity - Order quantity

Returns:

JSONObject which will have status.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection error.

getInstruments

public List<Instrument> getInstruments()
                                throws KiteException,
                                       IOException,
                                       org.json.JSONException

Retrieves list of market instruments available to trade. Response is array for objects. For example, { instrument_token: '131098372', exchange_token: '512103', tradingsymbol: 'NIDHGRN', name: 'NIDHI GRANITES', last_price: '0.0', expiry: '', strike: '0.0', tick_size: '0.05', lot_size: '1', instrument_type: 'EQ', segment: 'BSE', exchange: 'BSE' }, ...]

Returns:

List of instruments which are available to trade.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related errors.

org.json.JSONException

getInstruments

public List<Instrument> getInstruments(String exchange)
                                throws KiteException,
                                       org.json.JSONException,
                                       IOException

Retrieves list of market instruments available to trade for an exchange Response is array for objects. For example, { instrument_token: '131098372', exchange_token: '512103', tradingsymbol: 'NIDHGRN', name: 'NIDHI GRANITES', last_price: '0.0', expiry: '', strike: '0.0', tick_size: '0.05', lot_size: '1', instrument_type: 'EQ', segment: 'BSE', exchange: 'BSE' }, ...]

Parameters:

exchange - Filter instruments based on exchange. exchange can be NSE, BSE, NFO, BFO, CDS, MCX.

Returns:

List of instruments which are available to trade for an exchange.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection related error.

getQuote

public Map<String,Quote> getQuote(String[] instruments)
                           throws KiteException,
                                  org.json.JSONException,
                                  IOException

Retrieves quote and market depth for an instrument

Parameters:

instruments - is the array of tradingsymbol and exchange or instrument token. For example {NSE:NIFTY 50, BSE:SENSEX} or {256265, 265}

Returns:

Map of String and Quote.

Throws:

KiteException - is thrown for all Kite trade related errors.

org.json.JSONException - is thrown when there is exception while parsing response.

IOException - is thrown when there is connection related error.

getOHLC

public Map<String,OHLCQuote> getOHLC(String[] instruments)
                              throws KiteException,
                                     IOException,
                                     org.json.JSONException

Retrieves OHLC and last price. User can either pass exchange with tradingsymbol or instrument token only. For example {NSE:NIFTY 50, BSE:SENSEX} or {256265, 265}

Parameters:

instruments - is the array of tradingsymbol and exchange or instruments token.

Returns:

Map of String and OHLCQuote.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

getLTP

public Map<String,LTPQuote> getLTP(String[] instruments)
                            throws KiteException,
                                   IOException,
                                   org.json.JSONException

Retrieves last price. User can either pass exchange with tradingsymbol or instrument token only. For example {NSE:NIFTY 50, BSE:SENSEX} or {256265, 265}.

Parameters:

instruments - is the array of tradingsymbol and exchange or instruments token.

Returns:

Map of String and LTPQuote.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

getHistoricalData

public HistoricalData getHistoricalData(Date from,
                                        Date to,
                                        String token,
                                        String interval,
                                        boolean continuous,
                                        boolean oi)
                                 throws KiteException,
                                        IOException,
                                        org.json.JSONException

Retrieves historical data for an instrument.

Parameters:

from - "yyyy-mm-dd" for fetching candles between days and "yyyy-mm-dd hh:mm:ss" for fetching candles between timestamps.

to - "yyyy-mm-dd" for fetching candles between days and "yyyy-mm-dd hh:mm:ss" for fetching candles between timestamps.

continuous - set to true for fetching continuous data of expired instruments.

interval - can be minute, day, 3minute, 5minute, 10minute, 15minute, 30minute, 60minute.

token - is instruments token.

oi - set to true for fetching open interest data. The default value is 0.

Returns:

HistoricalData object which contains list of historical data termed as dataArrayList.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

getMFInstruments

public List<MFInstrument> getMFInstruments()
                                    throws KiteException,
                                           IOException,
                                           org.json.JSONException

Retrieves mutualfunds instruments.

Returns:

returns list of mutual funds instruments.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related errors.

org.json.JSONException

placeMFOrder

public MFOrder placeMFOrder(String tradingsymbol,
                            String transactionType,
                            double amount,
                            double quantity,
                            String tag)
                     throws KiteException,
                            IOException,
                            org.json.JSONException

Place a mutualfunds order.

Parameters:

tradingsymbol - Tradingsymbol (ISIN) of the fund.

transactionType - BUY or SELL.

amount - Amount worth of units to purchase. Not applicable on SELLs.

quantity - Quantity to SELL. Not applicable on BUYs. If the holding is less than minimum_redemption_quantity, all the units have to be sold.

tag - An optional tag to apply to an order to identify it (alphanumeric, max 8 chars).

Returns:

MFOrder object contains only orderId.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

cancelMFOrder

public boolean cancelMFOrder(String orderId)
                      throws KiteException,
                             IOException,
                             org.json.JSONException

If cancel is successful then api will respond as 200 and send back true else it will be sent back to user as KiteException.

Parameters:

orderId - is the order id of the mutualfunds order.

Returns:

true if api call is successful.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there connection related error.

org.json.JSONException

getMFOrders

public List<MFOrder> getMFOrders()
                          throws KiteException,
                                 IOException,
                                 org.json.JSONException

Retrieves all mutualfunds orders.

Returns:

List of all the mutualfunds orders.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

getMFOrder

public MFOrder getMFOrder(String orderId)
                   throws KiteException,
                          IOException,
                          org.json.JSONException

Retrieves individual mutualfunds order.

Parameters:

orderId - is the order id of a mutualfunds scrip.

Returns:

returns a single mutualfunds object with all the parameters.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

placeMFSIP

public MFSIP placeMFSIP(String tradingsymbol,
                        String frequency,
                        int installmentDay,
                        int instalments,
                        int initialAmount,
                        double amount)
                 throws KiteException,
                        IOException,
                        org.json.JSONException

Place a mutualfunds sip.

Parameters:

tradingsymbol - Tradingsymbol (ISIN) of the fund.

frequency - weekly, monthly, or quarterly.

amount - Amount worth of units to purchase. It should be equal to or greated than minimum_additional_purchase_amount and in multiple of purchase_amount_multiplier in the instrument master.

installmentDay - If Frequency is monthly, the day of the month (1, 5, 10, 15, 20, 25) to trigger the order on.

instalments - Number of instalments to trigger. If set to -1, instalments are triggered at fixed intervals until the SIP is cancelled.

initialAmount - Amount worth of units to purchase before the SIP starts. Should be equal to or greater than minimum_purchase_amount and in multiple of purchase_amount_multiplier. This is only considered if there have been no prior investments in the target fund.

Returns:

MFSIP object which contains sip id and order id.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

modifyMFSIP

public boolean modifyMFSIP(String frequency,
                           int day,
                           int instalments,
                           double amount,
                           String status,
                           String sipId)
                    throws KiteException,
                           IOException,
                           org.json.JSONException

Modify a mutualfunds sip.

Parameters:

frequency - weekly, monthly, or quarterly.

status - Pause or unpause an SIP (active or paused).

amount - Amount worth of units to purchase. It should be equal to or greated than minimum_additional_purchase_amount and in multiple of purchase_amount_multiplier in the instrument master.

day - If Frequency is monthly, the day of the month (1, 5, 10, 15, 20, 25) to trigger the order on.

instalments - Number of instalments to trigger. If set to -1, instalments are triggered at fixed intervals until the SIP is cancelled.

sipId - is the id of the sip.

Returns:

returns true, if modify sip is successful else exception is thrown.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

cancelMFSIP

public boolean cancelMFSIP(String sipId)
                    throws KiteException,
                           IOException,
                           org.json.JSONException

Cancel a mutualfunds sip.

Parameters:

sipId - is the id of mutualfunds sip.

Returns:

returns true, if cancel sip is successful else exception is thrown.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

getMFSIPs

public List<MFSIP> getMFSIPs()
                      throws KiteException,
                             IOException,
                             org.json.JSONException

Retrieve all mutualfunds sip.

Returns:

List of sips.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

getMFSIP

public MFSIP getMFSIP(String sipId)
               throws KiteException,
                      IOException,
                      org.json.JSONException

Retrieve an individual sip.

Parameters:

sipId - is the id of a particular sip.

Returns:

MFSIP object which contains all the details of the sip.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

getMFHoldings

public List<MFHolding> getMFHoldings()
                              throws KiteException,
                                     IOException,
                                     org.json.JSONException

Retrieve all the mutualfunds holdings.

Returns:

List of mutualfunds holdings.

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

logout

public org.json.JSONObject logout()
                           throws KiteException,
                                  IOException,
                                  org.json.JSONException

Logs out user by invalidating the access token.

Returns:

JSONObject which contains status

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

invalidateAccessToken

public org.json.JSONObject invalidateAccessToken()
                                          throws IOException,
                                                 KiteException,
                                                 org.json.JSONException

Kills the session by invalidating the access token.

Returns:

JSONObject which contains status

Throws:

KiteException - is thrown for all Kite trade related errors.

IOException - is thrown when there is connection related error.

org.json.JSONException

invalidateRefreshToken

public org.json.JSONObject invalidateRefreshToken(String refreshToken)
                                           throws IOException,
                                                  KiteException,
                                                  org.json.JSONException

Kills the refresh token.

Parameters:

refreshToken - is the token received after successful log in.

Returns:

JSONObject contains status.

Throws:

IOException - is thrown for connection related errors.

KiteException - is thrown for Kite trade related errors.

org.json.JSONException