Kite Class

DotNet Library For Kite Connect API

This class exposes all properties and methods supported by Kite Connect API

Inheritance Hierarchy

System.Object
KiteNet.Kite

Namespace: KiteNet
Assembly: KiteNet (in KiteNet.dll) Version: 1.3.0.0

Syntax

Copy

public class Kite : IDisposable

Public Class Kite
	Implements IDisposable

The Kite type exposes the following members.

Constructors

	Name	Description
	Kite	Initializes a new instance of the Kite class

Top

Properties

	Name	Description
	Access_Token	Get's Access Token
	Api_Key	Get's or Set's API Key
	Api_Secret	Get's or Set's API Secret
	App_Notification	Get's or Set's App Notification Status
	Authorization_Status	Get's Authorization Status
	BeginTimeOrderBookPull
	Bridge_Notification	Get's or Set's Bridge Notification Status
	BridgeExpiry	Get's Bridge Expiry Date
	BridgeStatus	Get's Bridge status
	Client_Email	Get's Client Email
	Client_Id	Get's Client Id
	Client_Name	Get's Client Name
	Client_Phone	Get's Client Phone
	DisableEvents
	Email_Alerts	Get's or Set's Email Alerts Status
	Email_Id_Alerts	Get's or Set's Email Id For Alerts
	EnableBridge	Get's or Set's Bridge Status
	EnableDomInRtd	Get's or Set's EnableDomInRtd
	EnableMaxLoss	Get's or Set's MaxLoss Status
	EnableMaxProfit	Get's or Set's MaxProfit Status
	EnableOrderBookPullOnError
	EnableSqoffMcx	Get's or Set's SqoffMcx Status
	EnableSqoffNse	Get's or Set's SqoffNse Status
	EnableWebsocket	Get's or Set's Websocket Status
	EndTimeOrderBookPull
	Excel_Mode	Get's or Set's Excel Mode
	Exchange_Enabled	Get's Exchanges Enabled For User
	ExchangesEnabled
	FileVersion	Get's File Version
	IsActiveClient	Get's User Account Status
	IsBOEnabled	Get's User BO Status
	IsCOEnabled	Get's User CO Status
	IsDownloadingHistData	Get's HistData download Status
	IsExitNrml
	IsInternetAvailable	Get's Internet Status
	IsProcessingBatchHistData	Get's Batch HistData Processing Status
	IsProcessingBatchOrder	Get's Batch Order Processing Status
	IsReconnectingWebsocket	Get's Websocket Reconnection Status
	IsSubscribingAllQuotes	Get's All Quotes Subscribing Status
	IsUnSubscribingAllQuotes	Get's All Quotes UnSubscribing Status
	IsWebSockLive	Get's Websocket Status
	ListExch
	ListInstTypeEq
	ListInstTypeFut
	ListInstTypeIdx
	ListSymbolBSEEq
	ListSymbolBSEFut
	ListSymbolBSEIdx
	ListSymbolBSEOpt
	ListSymbolMCXFut
	ListSymbolMCXOpt
	ListSymbolNCDFut
	ListSymbolNCDOpt
	ListSymbolNSEEq
	ListSymbolNSEFut
	ListSymbolNSEIdx
	ListSymbolNSEOpt
	Login_Response	Get's Login Response
	Login_Status	Get's Login Status
	Login_Url	Get's Login Url
	LogMTM	Get's or Set's MTM Log Status
	Logout_Status	Get's Logout Status
	LogTicks	Get's or Set's Ticks Log Status
	MaxLoss	Get's or Set's MaxLoss
	MaxProfit	Get's or Set's MaxProfit
	MaxSocketConnections	Get's Maximum Socket Connections
	Mobile_No_Alerts	Get's or Set's Mobile No For Alerts
	OnlyTopBidAsk
	Order_Notification	Get's or Set's Order Notification Status
	OrderBookPullInterval
	Position_Notification	Get's or Set's Position Notification Status
	Product_Enabled	Get's Products Enabled For User
	ProxyDomain	Get's or Set's Proxy Domain
	ProxyPassword	Get's or Set's Proxy Password
	ProxyPort	Get's or Set's Proxy Port
	ProxyServer	Get's or Set's Proxy Server
	ProxyUserName	Get's or Set's Proxy UserName
	Public_Token	Get's Public Property Token Implements IKite.Get's
	Redirect_Url	Get's or Set's Redirect Url
	Request_Token	Get's Request Token
	Root_EndPoint	Get's Root EndPoint
	RtdPingInterval	Get's or Set's RtdPingInterval
	RtdPingIntervalSelf
	SMS_Alerts	Get's or Set's SMS Alerts Status
	SocketExpiry	Get's Socket Expiry Date
	SocketStatus	Get's Socket status
	SourceIds	Get's or Set's SourceIds
	SqoffTimeMcx	Get's or Set's SqoffTimeMcx
	SqoffTimeNse	Get's or Set's SqoffTimeNse
	StgysEnabled	Get's List of Stgy's enabled for the user
	Stream_Mode	Get's or Set's Stream Mode
	Symbol_Download_Status	Get's Symbol Download Status
	Telegram_Alerts
	Telegram_UserName
	TickerCount	Get's number of symbols subscribed for quotes
	TicksLog_Mode	Get's or Set's Ticks Log Mode
	UseProxyServer	Get's or Set's Proxy Status
	User_Type	Get's User Type
	Version	Get's Version

Top

Methods

	Name	Description
	BatchOrderPlacement	This method can be used to place multiple orders at once
	CancelAmo	Cancels a after market order
	CancelBOMain	Cancels a open BO entry order
	CancelCOMain	Cancels a open CO entry order
	CancelRegularOrder	Cancels a open or trigger pending simple order
	CancelRegularOrder2
	DeleteIECookies	Deletes Internet Explorer Cache, Cookies and Browsing History.
	Dispose()	Releases all resources used by the Kite
	Dispose(Boolean)	Releases the unmanaged resources used by the Kite and optionally releases the managed resources
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	ExitBO	Exits a open BO position
	ExitCO	Exits a cover order position
	Finalize	Finalize (Overrides Object.Finalize().)
	GetAccessToken()	Retrieves Access Token from API server
	GetAccessToken(String)	Retrieves Access Token from API server
	GetAtp	Get's ATP for the symbol.
	GetAvgBoughtPrice	Get's Avg Bought Price for the symbol.
	GetAvgBoughtPriceProduct	Get's Avg Bought Price for the symbol and Product.
	GetAvgSoldPrice	Get's Avg Sold Price for the symbol.
	GetAvgSoldPriceProduct	Get's Avg Sold Price for the symbol and Product.
	GetBestAsk	Get's Best Ask for the symbol.
	GetBestAskQty	Get's Best Ask Qty for the symbol.
	GetBestBid	Get's Best Bid for the symbol.
	GetBestBidQty	Get's Best Bid Qty for the symbol.
	GetBoughtQty	Get's Bought Qty for the symbol.
	GetBoughtQtyProduct	Get's Bought Qty for the symbol and Product.
	GetBridgeLogs	Get's Bridge Logs
	GetBridgePositions	Get's Bridge Positions
	GetBridgePositionsAll	Get's All Bridge Positions
	GetChildOrders	Get's the Child Orders for BO\|CO
	GetClose	Get's Close for the symbol.
	GetContractExpiry
	GetExch	Returns the Exchange for the given InstToken
	GetExchToken	Get's Exch Token
	GetExpiry	Get's Expiry
	GetFunds	Retrieve's Funds and Margins from API server
	GetFutureTradeSymbol
	GetGrossMtm
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetHigh	Gets's High for the symbol.
	GetHistData	Gets the Historical data
	GetHistDataBatch	This method can be used to download and save historical data for multiple symbols at once
	GetHoldings	Retrieve's Holdings from API server
	GetIndexExpiry
	GetIndexExpiryText
	GetInstToken	Get's Inst Token
	GetISIN	Get's ISIN
	GetLastOrderId	Get's Id of the Last Placed order for the Exch, Symbol and Product Combination
	GetLotSize	Get's the Lot Size
	GetLow	Get's Low for the symbol.
	GetLowerCircuit	Get's Lower Circuit for the symbol.
	GetLtp	Get's Ltp for the symbol.
	GetLTQ	Get's LTQ for the symbol.
	GetLTT	Get's LTT for the symbol.
	GetLUT	Get's LUT for the symbol.
	GetMasterContract	Downloads Symbols for all exchanges enabled for user
	GetMtm	Get's MTM for the symbol.
	GetMtmProduct	Get's MTM for the symbol and Product.
	GetMWSymbols	Returns the list of symbols added to market watch
	GetNetQty	Get's Net Qty for the symbol.
	GetNetQtyProduct	Get's Net Qty for the symbol and Product.
	GetOIHigh	Get's Open Int High for the symbol.
	GetOILow	Get's Open Int Low for the symbol.
	GetOINetChg	Get's Open Int Net Chg for the symbol.
	GetOIPctChg	Get's Open Int Pct Chg for the symbol.
	GetOpen	Get's Open for the symbol.
	GetOpenInt	Get's Open Int for the symbol.
	GetOptionTradeSymbol
	GetOrderBook	Retrieve's Order Bookfrom API server
	GetOrderCTag	Get's OrderId for the given exch, trdsym and tag combination
	GetOrderDetails	Get's the Order Details
	GetOrderDiscQty	Get's the Order Disclosed Quantity
	GetOrderElapsed
	GetOrderExch	Get's the Order Exchange
	GetOrderExchId	Get's the Order ExchId
	GetOrderExchTime	Get's the Order Exch Time
	GetOrderExchToken	Get's the Order Exchange Token
	GetOrderFilledPrice	Get's the Order Filled Price
	GetOrderFilledQty	Get's the Order Filled Qty
	GetOrderHist	Get's the complete order history from API server
	GetOrderIds	Get's all Order Ids for the given Exch, Symbol and Product Combination
	GetOrderInstToken	Get's the Order Inst Token
	GetOrderIsAmo	Get's the Order AMO Status
	GetOrderMessage	Get's the Order Message
	GetOrderParentId	Get's the Order ParentId
	GetOrderPendingQty	Get's the Order Pending Quantity
	GetOrderPrice	Get's the Order Price
	GetOrderProdType	Get's the Order Product Type
	GetOrderQty	Get's the Order Qty
	GetOrderStatus	Get's the Order Status
	GetOrderTag	Get's the Order Tag (API Supported)
	GetOrderTime	Get's the Order Time
	GetOrderTrans	Get's the Order Transaction Type
	GetOrderTrdSym	Get's the Order Trade Symbol
	GetOrderTriggerPrice	Get's the Order Trigger Price
	GetOrderType	Get's the Order Type
	GetOrderValidDate	Get's the Order Valid Date
	GetOrderVariety	Get's the Order Variety
	GetPositions	Retrieve's Positionsfrom API server
	GetRequestTokenDriver
	GetSegment	Get's Segment
	GetSnapLtp	Gets the snap ltp for the given symbol from API server
	GetSnapOHLC	Gets the snap ohlc for the given symbol from API server
	GetSnapQuote	Gets the snap quote for the given symbol from API server
	GetSnapQuoteIndex	Gets the snap quote for the given index from API server
	GetSoldQty	Get's Sold Qty for the symbol.
	GetSoldQtyProduct	Get's Sold Qty for the symbol and Product.
	GetStrike	Get's Strike price
	GetSymbolFromTrdsym
	GetSymbols	Get's Symbol list
	GetTickSize	Get's Tick Size
	GetTotalBFOBrokerage
	GetTotalBFOMtm
	GetTotalBrokerage
	GetTotalBuyQty	Get's Total Buy Qty for the symbol.
	GetTotalCapital
	GetTotalCapital2
	GetTotalCash
	GetTotalCDSBrokerage
	GetTotalCDSMtm
	GetTotalMTM	Get's the total MTM of the given exchange.
	GetTotalNFOBrokerage
	GetTotalNFOMtm
	GetTotalSellQty	Gets's Total Sell Qty for the symbol.
	GetTradeBook	Retrieve's Trade Bookfrom API server
	GetTradeHist	Get's the complete trade history from API server
	GetTrdSym	Returns the Trade Symbol for the given Token
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUpperCircuit	Gets's Upper Circuit for the symbol.
	GetVolume	Get's Volume for the symbol.
	IsTrdsymValid
	Login()	Opens built-in WebBrowser control for login flow and retrieves the access code on succesful login.
	Login(String)	Opens user choosen browser for login flow.
	Logout	Logouts the user
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ModifyAmo	Modifies a open or trigger pending after market order
	ModifyBOMain	Modifies a open BO entry order
	ModifyBOSl	Modifies a open BO stoploss order
	ModifyBOTgt	Modifies a open BO target order
	ModifyCOSl	Modifies trigger price of a CO stoploss order
	ModifyRegularOrder	Modifies a open or trigger pending simple order
	ModifyRegularOrder2
	PlaceAmo	Places a after market order
	PlaceBO	Places a BO order
	PlaceCO	Places a cover order
	PlaceRegularOrder	Places a Regular Order
	PlaceRegularOrder2
	PositionConversion	Convert Position from One Product to another
	RefreshRTDQuotes	Refresh's RTD server quotes.
	SetAccessToken	Set's the earlier generated access token. If you have valid access token, then you can just skip Login and GetAccessToken calls. Login Method1 : Login --> GetAccessToken --> GetMasterContract Login Method2 : SetAccessToken --> GetMasterContract
	ShowHistDataInputBox	Displays a Input Box where the user can enter or select symbol details required for GetHistData() Call.
	ShowInputBox	Displays a simple Input Box where the user will be prompt to enter value.
	ShowMarketDepth	Show Market depth for the given Trade Symbol
	ShowModifyWindow(Boolean)	Displays Modify Order Window where a user can modify/cancel order in UI mode.
	ShowModifyWindow(String, Boolean)	Displays Modify Order Window where a user can modify/cancel order in UI mode.
	ShowMsgBox	Displays a simple Message Box .
	ShowMsgBoxOkCancel	Displays a simple OkCancel Message Box .
	ShowMultiInputBox	Displays a simple Multi Input Box where the user will be prompt to enter multiple values.
	ShowOptionOrderWindow	Displays New Option Order Window where a user can place order in UI mode.
	ShowOrderWindow(Boolean)	Displays New Order Window where a user can place order in UI mode.
	ShowOrderWindow(String, String, String, String, Int32, String, String, Double, Double, Double, Double, Double, Boolean)	Displays Order Window where a user can place a order in UI mode.
	ShowOrderWindowBridge	Displays Order Window where a user can place order through Bridge class.
	ShowSettingsWindow	Displays Settings Window where a user can input API details in UI mode.
	StartWebSocket	Starts WebSocket for Streaming Quotes
	StopWebSocket	Stops WebSocket from Streaming Quotes
	SubscribeMultiQuotes	Subscribes quotes for multiple symbols
	SubscribeQuotes	Subscribes quotes for the given symbol
	SubscribeQuotesAll	Subscribes quotes for all symbols in the market watch.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnSubscribeMultiQuotes	UnSubscribes quotes for multiple symbol
	UnSubscribeQuotes	UnSubscribes quotes for the given symbol
	UnSubscribeQuotesAll	UnSubscribes quotes for all symbols in market watch

Top

Events

	Name	Description
	AppUpdateEvent	This is raised whenever critical app events occurs like network disconnection etc
	MtmUpdateEvent	This is raised whenever any changes in the MTM
	OrderUpdateEvent	This is raised whenever order updates arrives from API server
	PositionUpdateEvent	This is raised whenever any changes in the positions
	QuotesReceivedEvent	This is raised whenever new data arrives from API server
	TradeUpdateEvent	This is raised whenever trade updates arrives from API server

Top

Remarks

Log folder : [APPDIR]\KiteNet\[DDMMMYYYY]
To use with excel, you need to register the KiteNet.dll using regasm as per your excel bit.
You can download the KiteNet.zip file from https://howutrade.in and follow the notes.
Batch file to register the DLL is included in the zip file.
You can get start with our Sample Excel Sheet or App.

Examples

***** Using in Visual Studio *****
'Add reference to KiteNet.dll in your project.
Imports KiteNet

Public Class SampleApp
Dim Kite as Kite = New Kite 'Creates a New Instance of Kite
End Class

***** Using in Excel *****
'Early Binding Example
'Add reference to KiteNet.dll in Visaul Basic Editor by
Menu --> Tools --> Add Reference --> Select 'DotNet Library For Kite Connect API'

Dim Kite as New Kite 'Creates a New Instance of Kite

'Late Binding without adding Reference
Dim Kite as Object
Set Kite = CreateObject("KiteNet.Kite")

Reference

KiteNet Namespace