#pocket #api-bindings #com #oauth #token #consumer #getpocket


Async bindings for Pocket API (https://getpocket.com)

1 unstable release

0.1.0 Feb 8, 2021

#649 in Authentication

24 downloads per month


1.5K SLoC


Coverage Status

Pocket API bindings (http://getpocket.com)

API is very easy, actually. The most complex code is for authorization. You will need a consumer key and an access token in order to use the API.

A consumer_key can be obtained by creating an app at the My Applications page. An access token is obtained by walking through OAuth authentication workflow.

The OAuth workflow is implemented with a pair of methods in this implementation:

let auth = PocketAuthentication::new("YOUR-CONSUMER-KEY-HERE", "rustapi:finishauth");
let state = None;
let code = auth.request(state).await?;
println!("Follow auth URL to provide access and press enter when finished: {}", auth.authorize_url(&code));
let _ = std::io::stdin().read_line(&mut String::new());

let user = auth.authorize(&code, state).await?;

So you

  1. Initiate auth with PocketAuthentication::new()
  2. Generate OAuth access request URL with auth.request(),
  3. Let the user follow the URL and confirm app access
  4. Call auth.authorize() and either get an error, or the username and access token of user just authorized.

You can then convert that user into an Pocket instance if you choose.

let pocket = user.pocket();

I recommend storing the access token after you get it, so you don't have to repeat this workflow again next time. The access token can be obtained via user.access_token field. Store it somewhere and use it to construct a Pocket instance:


A Pocket instance allows you to add, modify and retrieve items to and from your pocket.

To add an item, use the Pocket::add() or Pocket::send() method:

// Add with all meta-info provided (title, tags, tweet id)
let added_item = pocket.add(&PocketAddRequest::new(&url)
    .title("Example title")

// Add with one or more actions
let added_item = pocket.send(&PocketSendRequest { 
    actions: &[
        &PocketSendAction::Add {
            item_id: None,
            ref_id: None,
            tags: Some("example-tag".to_string()),
            time: None,
            title: Some("Example title".to_string()), 
            url: Url::parse("https://example.com").ok(), 

To query your pocket, use Pocket::filter() and Pocket::get() methods:

let mut f = pocket.filter();
f.complete(); // complete data
f.archived(); // archived items only
f.videos();   // videos only
f.offset(10); // items 10-20
f.sort_by_title(); // sorted by title
// There are more methods, see `PocketGetRequest` struct for details

let items = pocket.get(&f).await; // get items

To modify one or multiple items or tags at a time, use Pocket::send()

let item_id = 1583845180185;
let results = pocket.send(&PocketSendRequest {
    actions: &[
        &PocketSendAction::Archive { item_id, time: None },
        &PocketSendAction::TagsAdd { item_id, tags: "one,two".to_string(), time: None },
        &PocketSendAction::TagRename { old_tag: "one".to_string(), new_tag: "1".to_string(), time: None },


Licensed under either of

at your option.


Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.


~351K SLoC