Interface: KiteConnectParams

Params to construct a KiteConnect class.

Properties

access_token

Optional access_token: string

Token obtained after the login flow in exchange for the request_token. Pre-login, this will default to null, but once you have obtained it, you should persist it in a database or session to pass to the Kite Connect class initialisation for subsequent requests.

Default Value

null

api_key

api_key: string

API key issued to you.

debug

Optional debug: boolean

If set to true, will console log requests and responses.

Default Value

false

login_uri

Optional login_uri: string

Kite connect login url

Default Value

"https://kite.trade/connect/login"

root

Optional root: string

API end point root. Unless you explicitly want to send API requests to a non-default endpoint, this can be ignored.

Default Value

"https://api.kite.trade"

timeout

Optional timeout: number

Time (milliseconds) for which the API client will wait for a request to complete before it fails.

Default Value

7000