Interface: KiteTickerParams

Params to construct a KiteTicker class

Properties

access_token

access_token: string

Access token obtained after successful login flow.

api_key

api_key: string

API key issued to you.

max_delay?

optional max_delay?: number

The maximum delay in seconds after which subsequent re-connection interval will become constant. Defaults to 60s and minimum acceptable value is 5s.

Default Value

60

max_retry?

optional max_retry?: number

The maximum number of re-connection attempts. Defaults to 50 attempts and maximum up to 300 attempts.

Default Value

50

reconnect?

optional reconnect?: boolean

Enable/Disable auto reconnect. Enabled by default.

Default Value

true

root?

optional root?: string

Kite websocket root.

Default Value

"wss://ws.kite.trade/"