Users

User profile

User API provides user's info like name, email, mobile, PAN, demat details, bank details , exchanges allowed, Ordertypes allowed etc.

User profile

Type	Endpoint	Description
GET	/user/	Get user profile

Get user profile

Get the user profile information.

Request

curl --location --request GET 'https://{BASEURL}broking/api/v0/user/
--header 'access-token: access-token' \
--header 'Content-Type: application/json' \
--data-raw ''

Response In Success response, we get the user profile details. If HTTP status code is received in response like 4xx or 5xx, this means failure or exceptions.

{
    "name": "Abhishek Kumar",
    "mobile_number": "9999988888",
    "exchange": [
        1,
        2,
        3
    ],
    "order_types": [
        {
            "order_type": 6,
            "exchange": [
                1,
                3
            ]
        },
        {
            "order_type": 5,
            "exchange": [
                1,
                3,
                2
            ]
        },
        {
            "order_type": 4,
            "exchange": [
                1,
                3,
                2
            ]
        },
        {
            "order_type": 3,
            "exchange": [
                2,
                1,
                3
            ]
        },
        {
            "order_type": 2,
            "exchange": [
                1,
                3,
                2
            ]
        },
        {
            "order_type": 1,
            "exchange": [
                1,
                3
            ]
        }
    ],
    "price_types": null,
    "broker_name": "WEALTHY",
    "branch_id": "BLR",
    "email": "[email protected]",
    "pan": "AAAAA1111L",
    "mandate_list": [],
    "bankDetails": [
        {
            "bank_name": "STATE BANK OF INDIA",
            "account_number": "00000039643936440",
            "ifsc_code": "SBIN0010600"
        }
    ],
    "address": "MHOW 73,MANAS RAJAT VIHAR,COLONY KODARIYA,DELHI ",
    "office": "MHOW 73,MANAS RAJAT VIHAR,COLONY KODARIYA,DELHI",
    "city": "",
    "state": ""
}

User profile attributes

Field	Field type	Description
name	integer	User's name
mobile_number	string	Mobile number
exchange	[]int	list of exchange segments enabled for the user. see details
order_types	Dictionary of order_type and list of exchange	map of applicable order types and exchange. see ordertypes enum. see details
price_types	string	price types allowed for the user.see details
broker_name	string	name of the broker
branch_id	string	Name of the branch
email	string	email id
pan	string	Pan card number
mandate_list	[]string	list of mandates
bankDetails	[]string	Bank details
address	string	Address
office	string	Office
city	string	City
state	string	State