Interface: SessionData
Response after successful authentication.
Properties
access_token
access_token: string
The authentication token that's used with every subsequent request
Unless this is invalidated using the API, or invalidated by a master-logout
from the Kite Web trading terminal, it'll expire at 6 AM on the next day (regulatory requirement)
api_key
api_key: string
The API key for which the authentication was performed
avatar_url
avatar_url: string
Full URL to the user's avatar (PNG image) if there's one
broker
broker: string
The broker ID
email: string
User's email
exchanges
exchanges: string[]
Exchanges enabled for trading on the user's account
login_time
login_time: string
User's last login time
meta
meta: Object
A token for public session validation where requests may be exposed to the public
Type declaration
| Name | Type | Description |
|---|---|---|
demat_consent | string | empty, consent or physical |
order_types
order_types: string[]
Order types enabled for the user
products
products: string[]
Margin product types enabled for the user
public_token
public_token: string
A token for public session validation where requests may be exposed to the public
refresh_token
refresh_token: string
A token for getting long standing read permissions. This is only available to certain approved platforms
user_id
user_id: string
The unique, permanent user id registered with the broker and the exchanges
user_name
user_name: string
User's real name
user_shortname
user_shortname: string
Shortened version of the user's real name
user_type
user_type: string
User's registered role at the broker. This will be individual for all retail users