pocketful logo light
pocketful logo light

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 NameValueDescription
x-authorization-token<your_access_token>Valid JWT token for authentication
x-device-typeWEBThe 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

KeyDescription
dataMain container for the user profile information.
broker_idThe name of the broker (e.g., Pocketful).
client_idThe unique identifier for the client.
email_idThe registered email address of the client.
exchanges_subscribedA JSON string listing the exchanges the client is subscribed to.
lastlogintimeThe timestamp of the client’s last login.
nameThe full name of the client.
phone_numberThe registered phone number of the client.
products_enabledA JSON string listing the trading products enabled for the client.
errorcodeSpecific error code if the request failed.
messageA descriptive message about the status of the request (e.g., SUCCESS).
statusBoolean indicator of the request success (true/false).

Error Response

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