TheDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/anurag-roy/kiteconnect-ts/llms.txt
Use this file to discover all available pages before exploring further.
KiteConnectParams interface defines the configuration object you pass to the KiteConnect constructor. Only api_key is required — all other fields have sensible defaults that work for most applications.
Parameters
The API key issued to you by Zerodha when you registered your app. Every request to the Kite Connect API is authenticated using this key together with an
access_token.The session token obtained after a successful login flow in exchange for a
request_token. Before the user logs in this is null. Once you obtain it you should persist it (database, session store, etc.) and pass it here on subsequent requests so you avoid a new login on every startup.Default: nullThe base URL for all REST API calls. You only need to change this if you are testing against a staging environment or a custom proxy.Default:
"https://api.kite.trade"The URL to which users are redirected to complete the OAuth login flow. Override this only if Zerodha provides you with a custom login endpoint.Default:
"https://kite.trade/connect/login"When set to
true, the client logs every outgoing request and incoming response to the console. Useful during development; keep it false in production to avoid leaking tokens.Default: falseThe number of milliseconds the HTTP client waits for a response before rejecting the request with a network error. Increase this value if you are on a slow network or if you are fetching large instrument dumps.Default:
7000