Struct SessionData

pub struct SessionData {

    pub user_id: String,
    pub user_name: String,
    pub user_shortname: String,
    pub email: String,
    pub user_type: String,
    pub broker: String,
    pub exchanges: Vec<String>,
    pub products: Vec<String>,
    pub order_types: Vec<String>,
    pub api_key: String,
    pub access_token: String,
    pub public_token: String,
    pub refresh_token: String,
    pub login_time: String,
    pub meta: Option<SessionMeta>,
    pub avatar_url: Option<String>,
}

Response from the generate_session API call

Fields

user_id: String

The unique, permanent user id registered with the broker and the exchanges

user_name: String

User’s real name

user_shortname: String

Shortened version of the user’s real name

email: String

User’s email

user_type: String

User’s registered role at the broker. This will be individual for all retail users

broker: String

The broker ID

exchanges: Vec<String>

Exchanges enabled for trading on the user’s account

products: Vec<String>

Margin product types enabled for the user

order_types: Vec<String>

Order types enabled for the user

api_key: String

The API key for which the authentication was performed

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)

public_token: String

A token for public session validation where requests may be exposed to the public

refresh_token: String

A token for getting long standing read permissions. This is only available to certain approved platforms

login_time: String

User’s last login time

meta: Option<SessionMeta>

Session metadata containing demat_consent and other user metadata

avatar_url: Option<String>

Full URL to the user’s avatar (PNG image) if there’s one

Implementations

impl SessionData

pub fn is_valid(&self) -> bool

Check if the session has required authentication data

pub fn token(&self) -> &str

Get the access token for API requests

pub fn has_exchange(&self, exchange: &str) -> bool

Check if the user has access to a specific exchange

pub fn has_product(&self, product: &str) -> bool

Check if the user has access to a specific product

pub fn has_order_type(&self, order_type: &str) -> bool

Check if the user has access to a specific order type

Trait Implementations

impl Clone for SessionData

fn clone(&self) -> SessionData

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SessionData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SessionData

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.