GET/api/v3/generate-authcode

Generate Auth Code

This API allows you to send a user to the FYERS login page and receive an auth code on your redirect URI.

USE CASE

Start the login for your own FYERS account and receive an auth_code on your redirect_uri.

Details

Open this URL in the user's browser (a GET request); the user then logs in with their FYERS credentials.
redirect_uri must be the same URL provided at app creation. Example: https://trade.fyers.in/api-login/redirect-uri/index.html.
Send a random state. The same value is returned after a successful login, so verify it before using the code.
The redirect carries an auth_code, which you exchange for an access token with Validate Auth Code.
Use a redirect_uri that is in your control, not a public endpoint such as google.com, because the auth token is sensitive.

Request Attributes

Attribute	Data Type	Description
`client_id`	string	This is the app_id which you have received after creating the app. Eg: “qwerty-100”
`redirect_uri`	string	This is where the user will be redirected after successful login. Eg: https://trade.fyers.in/api-login/redirect-uri/index.html This should be the same as what was provided at the time of app creation
`response_type`	string	This value must always be “code”
`state`	string	You send a random value. The same value will be returned after successful login to the redirect uri. Eg: “abcdefg”

Response Attributes

Attribute	Data Type	Description
`s`	string	ok / error
`code`	int	This is the code to identify specific responses
`message`	string	This is the message to identify the specific error responses
`auth_code`	string	String value which will be used to generate the access_token
`state`	string	This value is returned as is from the first request

Request

# Import the required module from the fyers_apiv3 package
from fyers_apiv3 import fyersModel

# Replace these values with your actual API credentials
client_id = "SPXXXXE7-100"
secret_key = "N********B"
redirect_uri = "https://trade.fyers.in/api-login/redirect-uri/index.html"
response_type = "code"  
state = "sample_state"

# Create a session model with the provided credentials
session = fyersModel.SessionModel(
    client_id=client_id,
    secret_key=secret_key,
    redirect_uri=redirect_uri,
    response_type=response_type
)

# Generate the auth code using the session model
response = session.generate_authcode()

# Print the auth code received in the response
print(response)

https://api-t1.fyers.in/api/v3/generate-authcode?
client_id=SPXXXXE7-100&
redirect_uri=https%3A%2F%2Fdev.fyers.in%2Fredirection%2Findex.html
&response_type=code&state=sample_state&nonce=sample_nonce

Generate Auth Code

Request Attributes

Response Attributes

Video learning