Profile

This API allows you to fetch the basic details of the account holder and confirm that your access token is valid.

Official reference: Profile

USE CASE

Check that your access token works right after login and see which FYERS account it belongs to.

The response also flags whether DDPI and MTF are enabled.

Details

This allows you to fetch basic details of the client.
Your app needs the Basic permission. It covers Profile Details, Logout App and Logout.
The request takes no parameters. Send only the Authorization header.
The response gives the account holder details (name, display_name, fy_id, email_id, mobile_number, pan, image) and security details (totp, pin_change_date, pwd_change_date, pwd_to_expire).
ddpi_enabled and mtf_enabled are booleans for the account's DDPI and MTF status.
Personally identifiable information in the response is masked for privacy and compliance. Report any problem to [email protected].
An expired or invalid token is rejected with error code -8, -15, -16 or -17. See API Error Codes.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Response Attributes

Attribute	Data Type	Description
`name`	string	Name of the client
`display_name`	string	Display name, if any, provided by the client
`fy_id`	string	The client id of the fyers user
`image`	string	URL link to the user’s profile picture, if any.
`email_id`	string	Email address of the client
`pan`	string	PAN of the client
`pin_change_date`	string	Date when last PIN was updated
`pwd_change_date`	string	Date when last password was updated
`mobile_number`	string	Registered mobile number
`totp`	boolean	Status of TOTP
`pwd_to_expire`	int	Number of days until the current password expires
`ddpi_enabled`	boolean	Status of DDPI
`mtf_enabled`	boolean	Status of MTF

Note: As per our privacy policy and in line with compliance requirements, PII (Personally Identifiable Information) information will be masked to safeguard customer information. If you notice any issues, please report to us at [email protected] for remedial action as may be necessary.

Request

from fyers_apiv3 import fyersModel

client_id = "XC4XXXXM-100"
access_token = "eyJ0eXXXXXXXX2c5-Y3RgS8wR14g"

# Initialize the FyersModel instance with your client_id, access_token, and enable async mode
fyers = fyersModel.FyersModel(client_id=client_id, is_async=False, token=access_token, log_path="")

# Make a request to get the user profile information
response = fyers.get_profile()

# Print the response received from the Fyers API
print(response)

{
    "s":"ok",
    "code":200,
    "message":"",
    "data":{
        "fy_id":"XXXXX86",
        "name":"JOHN",
        "image":"https://fyers-user-details.s3.amazonaws.com/image/FK0000000001?X-Amz-Algorithm=AWS4-HMAC",
        "display_name":"JD",
        "pin_change_date":"15-12-2022 09:24:05",
        "email_id":"[email protected]",
        "pwd_change_date":"None",
        "PAN": "FYxxxxxx0S",
        "mobile_number": "99xxxxxx99",
        "totp":True,
        "pwd_to_expire":90
        "ddpi_enabled": False,
        "mtf_enabled": False
    }
  }

Profile

Response Attributes

Video learning