Individual Profile

The Profile API retrieves basic account details and subscription information for a specific user, including enabled exchanges and trading products.

Endpoint: /v1/user/profile
Method-Type: GET

Headers

Header Name	Value	Description
x-authorization-token	<your_access_token>	Valid JWT token for authentication
x-device-type	WEB	The device type (e.g., WEB, ANDROID, IOS)

Query Params

{ 
  "client_id": "<client id>"
}

Example cURL Request

curl --location 'https://algo.pocketful.in/v1/user/profile?client_id=<client_id>' \
--header 'x-authorization-token: <your_access_token>' \
--header 'x-device-type: WEB'

Response

{
  "data": {
    "broker_id": "Pocketful",
    "client_id": "<client id>",
    "email_id": "<email id>",
    "exchanges_subscribed": "[\"BFO\",\"BSE\",\"MCX\",\"NFO\",\"NSE\"]",
    "lastlogintime": "",
    "name": "<name>",
    "phone_number": "<phone number>",
    "products_enabled": "[\"NRML\",\"MIS\",\"CNC\",\"MTF\"]"
  },
  "errorcode": "",
  "message": "SUCCESS",
  "status": true
}

Response Parameters

Key	Description
data	Main container for the user profile information.
broker_id	The name of the broker (e.g., Pocketful).
client_id	The unique identifier for the client.
email_id	The registered email address of the client.
exchanges_subscribed	A JSON string listing the exchanges the client is subscribed to.
lastlogintime	The timestamp of the client's last login.
name	The full name of the client.
phone_number	The registered phone number of the client.
products_enabled	A JSON string listing the trading products enabled for the client.
errorcode	Specific error code if the request failed.
message	A descriptive message about the status of the request (e.g., SUCCESS).
status	Boolean indicator of the request success (true/false).

Error Response

{
  "status": "error",
  "message": "Request forbidden",
  "error_code": 40000,
  "data":{
  }
}