Wrapper Around the 'Pocket' API
Functions that interface with the 'Pocket' API (<https://getpocket.com/developer/>). Allows the user to get, add, and modify items in their own 'Pocket' account.
This is a R wrapper for the Pocket API. You can use
pocketapi to access and modify your own pockets and to add new links to your Pocket programmatically.
The package is not yet on CRAN.
Current Development Version
This package is currently only available on GitHub. You can install it using
# install devtools package if it's not already install.packages("devtools") # install package from GitHub devtools::install_github("correlaid/pocketapi") # load package library(pocketapi)
Create a Pocket Application
You need to create a Pocket application in the Pocket developer portal to access your Pocket data. Don't worry: this app will only be visible to you and only serves the purpose of acquiring the credentials for
- Log in to your Pocket account and go to https://getpocket.com/developer/apps/new.
- Click "Create New Application". You'll be presented with a form. Choose a sensible application name and a description.
- Give your app permissions: Depending on the permissions of your app, you'll be able to use all or a subset of the
||what it does||needed permission|
||get data frame of all your pockets||Retrieve|
||add new Pocket entries||Modify|
- Check any platform for your app - this does not really matter but you need to check at least one box.
- Accept the terms of service and click "Create Application".
Get consumer key and token
pocketapi uses the OAuth2 flow provided by the Pocket Authentication API to get an access token for your App. Because Pocket does not closely follow the OAuth standard, we could not provide as smooth an experience as other packages do (e.g. googlesheets4). Instead, the user has to do the following once to obtain an access token:
Request a request token.
request_token <- get_request_token(consumer_key)
Authorize your app by entering the URL created by
create_authorize_urlin your browser:
:warning: This step is critical: Even if you have authorized your app before and you want to get a new access token, you need to do the authorization in your browser again. Otherwise, the request token will not be authorized to generate an access token!
- Get access token using the now authorized request token
access_token <- get_access_token(consumer_key, request_token)
You can now already use the package by specifying the consumer key and access token manually as arguments to each function call:
pocketapi::pocket_get(consumer_key = consumer_key, access_token = access_token)
To make it easier to work with the package, you should set them as environment variables.
Add the consumer key and access token to your environment
Important: Never make your
access_token publicly available - anyone will be able to access your Pockets!
It is common practice to set API keys in your R environment file so that every time you start R the key is loaded.
pocketapi functions access your
access_token automatically by executing
Sys.getenv("POCKET_ACCESS_TOKEN") . Alternatively, you can provide an explicit definition of your
access_token with each function call.
In order to add your key to your environment file, you can use the function
edit_r_environ from the
This will open your
.Renviron file in the RStudio editor. Now, you can add the following lines to it:
Save the file and restart R for the changes to take effect.
.Renviron lives at a non-conventional place, you can also edit it manually using RStudio or your favorite text editor.
If you don't want to clutter the
.Renviron file in your home folder, you can also use a local
.Renviron file in your project folder and read it in using the
readRenviron() function. In this case, make sure to never share your local
Get, modify, and add Pockets
Check out the vignette to see in more detail how to add, get, and modify your Pockets using those functions.
This package has some limitations:
- You can only modify your own Pockets.
- The Pocket API does not follow REST API standards and exhibits some weird behaviours. For example, even if a
modifyaction is not successful, the API will still return "success". See [issue #26 for a discussion of weird behaviours of the API.
Contributions to this package are welcome. Please see
Functions in pocketapi
Vignettes of pocketapi
Last month downloads
|License||MIT + file LICENSE|
|Packaged||2020-11-19 08:30:07 UTC; yannik|
|Date/Publication||2020-11-20 10:20:02 UTC|
Include our badge in your README