Interface: UserProfile
User prodile response.
Properties
avatar_url
avatar_url: null | 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
meta
meta: Object
Type declaration
| Name | Type | Description |
|---|---|---|
demat_consent | string | demat_consent: 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
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