Logout

This API allows you to invalidate the access token of your app without affecting other apps or web and mobile sessions.

USE CASE

Revoke the access token when a user signs out of your app.

Other apps and FYERS web and mobile sessions stay signed in.

Note

This revokes the token only for the specific app. Other active apps and FYERS web or mobile sessions stay signed in.

Details

This invalidates the access token, revoking it only for the specific app without affecting other active apps or web and mobile sessions.
Your app needs the Basic permission. It covers Logout and Logout App, along with Profile Details.
The request takes no body or parameters. Send a POST with only the Authorization header.
After a successful logout the access token is invalid. Get a new one through the Authentication flow before calling any other API.
Rate limits differ between the Standard and Prime plans. See Plans & rate limits.

Response Attributes

Attribute	Data Type	Description
`s`	string	Request status - "ok" when the logout succeeds.
`code`	int	Response status code, e.g. 200 on success.
`message`	string	Human-readable message confirming the user was successfully logged out.

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 for logout
response = fyers.logout()

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

{
  "s": "ok",
  "code": 200,
  "message": "you are successfully logged out",
}