Authenticating via OAuth¶
PRAW supports the three types of applications that can be registered on Reddit. Those are:
Before you can use any one of these with PRAW, you must first register an application of the appropriate type on Reddit.
Script applications are the simplest type of application to work with
because they don’t involve any sort of callback process to obtain an
While script applications do not involve a redirect uri, Reddit still
requires that you provide one when registering your application –
http://localhost:8080 is a simple one to use.
In order to use a script application with PRAW you need four pieces of information:
|client_id:||The client ID is the 14 character string listed just under “personal use script” for the desired developed application|
|client_secret:||The client secret is the 27 character string listed adjacent to
|password:||The password for the Reddit account used to register the script application.|
|username:||The username of the Reddit account used to register the script application.|
With this information authorizing as
username using a script app is as
reddit = praw.Reddit(client_id='SI8pN3DSbt0zor', client_secret='xaxkj7HNh8kwg8e5t4m6KvSrbTI', password='1guiwevlfo00esyy', user_agent='testscript by /u/fakebot3', username='fakebot3')
To verify that you are authenticated as the correct user run:
The output should contain the same name as you entered for
If the following exception is raised, double check your credentials, and ensure that that the username and password you are using are for the same user with which the script application is associated:
OAuthException: invalid_grant error processing request
A 2FA token can be used by joining it to the password with a colon:
reddit = praw.Reddit(client_id='SI8pN3DSbt0zor', client_secret='xaxkj7HNh8kwg8e5t4m6KvSrbTI', password='1guiwevlfo00esyy:955413', user_agent='testscript by /u/fakebot3', username='fakebot3')
However, for an automated script there is little benefit to using 2FA. The token must be refreshed after one hour; therefore, the 2FA secret would have to be stored along with the rest of the credentials in order to generate the token, which defeats the point of having an extra credential beyond the password.
If you do choose to use 2FA, you must handle the
that will be raised by API calls after one hour.
A web application is useful for two primary purposes:
- You have a website and want to be able to access Reddit from your users’ accounts.
- You want to limit the access one of your PRAW-based programs has to Reddit, or simply do not want to pass your username and password to PRAW.
When registering a web application you must provide a valid redirect uri. If you are running a website you will want to enter the appropriate callback URL and configure that endpoint to complete the code flow.
If you aren’t actually running a website, you can use the Obtaining a Refresh Token
script to obtain
http://localhost:8080 as the
redirect uri when using this script.
Whether or not you use the script there are two processes involved in obtaining access or refresh tokens.
The code flow can be used with an installed application just as described
above with one change: set the value of
The implicit flow is similar, however, the token is returned directly as part
of the redirect. For the implicit flow call
url() like so:
print(reddit.auth.url(['identity'], '...', implicit=True)
implicit() to provide the authorization to the
Using a Saved Refresh Token¶
A saved refresh token can be used to immediately obtain an authorized instance
reddit = praw.Reddit(client_id='SI8pN3DSbt0zor', client_secret='xaxkj7HNh8kwg8e5t4m6KvSrbTI', refresh_token='WeheY7PwgeCZj4S3QgUcLhKE5S2s4eAYdxM', user_agent='testscript by /u/fakebot3') print(reddit.auth.scopes())
The output from the above code displays which scopes are available on the
redirect_uri does not need to be provided in such
cases. It is only needed when
url() is used.
Read Only Mode¶
All application types support a read only mode. Read only mode provides access
to Reddit like a logged out user would see including the default Subreddits in
In the absence of a
refresh_token both web and installed
applications start in the read only mode. With such applications read
only mode is disabled when
successfully called. Script applications start up with read only mode
Read only mode can be toggled via:
# Enable read only mode reddit.read_only = True # Disable read only mode (must have a valid authorization) reddit.read_only = False