Crate wallabag_api[][src]

Expand description

Wallabag API

Provides full type-safe async access to a Wallabag API server. Contains methods for creating, reading, modifying, and deleting entries, annotations, and tags.

Example code to retrieve and print all starred entries.

use std::env;

use wallabag_api::types::{Config, EntriesFilter, SortBy, SortOrder};
use wallabag_api::Client;

async fn run_example() {
    let config = Config {
        client_id: env::var("WALLABAG_CLIENT_ID").expect("WALLABAG_CLIENT_ID not set"),
        client_secret: env::var("WALLABAG_CLIENT_SECRET").expect("WALLABAG_CLIENT_SECRET not set"),
        username: env::var("WALLABAG_USERNAME").expect("WALLABAG_USERNAME not set"),
        password: env::var("WALLABAG_PASSWORD").expect("WALLABAG_PASSWORD not set"),
        base_url: env::var("WALLABAG_URL").expect("WALLABAG_URL not set"),

    println!("{:#?}", config);

    let mut client = Client::new(config);

    let filter = EntriesFilter {
        archive: None,
        starred: Some(true),
        sort: SortBy::Created,
        order: SortOrder::Desc,
        tags: vec![],
        since: 0,
        public: None,
        per_page: None,

    let response = client.get_entries_with_filter(&filter).await;
    match response {
        Err(e) => {
            println!("Error: {}", e);
        Ok(entries) => {
            // do something with the entries!
            for entry in entries {
                    "{} | {} | Starred at {}",

fn main() {


pub use crate::errors::ClientError;


Client error types.

All types used by the client. Some are returned by the client and shouldn’t need to be created manually, while others are designed to be created and passed to client methods (eg. creating new entries).


The main thing that provides all the methods for interacting with the Wallabag API.