NOTE: This library is currently in prerelease, not all endpoints have been added and breaking changes could happen often before 1.0.0.

Arnak

Rust library for BoardGameGeek XML API bindings.

It should be noted that the underlying API can return information from RpgGeek and VideoGameGeek but these are purposely hidden for consistency, and to avoid confusion. For example, the collection endpoint only returns board games in the user's collection, and not RPG or video games that the same user has on the respective site collections.

Example

This example uses Tokio, so it would also be needed as a dependency:

[dependencies]
arnak = { version = "0.7.0" }
tokio = { version = "1" }

use arnak::BoardGameGeekApi;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let api = BoardGameGeekApi::new("my_auth_token").expect("something went wrong");
    let collection = api.collection().get_owned("bluebearbgg").await;
    match collection {
        Ok(collection) => println!("bluebearbgg owns {} games.", collection.items.len()),
        Err(e) => println!("Error: {e}"),
    }

    Ok(())
}

Endpoints

Accessory

Request details for a board game accessory, such as a playmat or meeple, by ID.

Collection

For a given user, return their collection of board games. This does not just mean games owned by the user, but also ones on their wishlist, previously owned, etc...

Collection Brief

Same as the collection endpoint, but without some additional stats for each item in the collection.

Forum

Request a forum by its ID, along with the list of threads in that forum.

Forum Group

Request information about a forum group, which is a list of forums under a certain domain such as for a specific game or game family. Will return the list of forums in that forum group.

Game Family

Request a family or number of families by their IDs. A game family is a group of games and expansions that fall under a certain group or name. For example Catan and Carcassone both have game families containing all of their respective expansions and related games.

Game

Request details for a board game or expansion by ID.

Guild

Request details about a guild and its members by ID.

Hot list

Returns the top 10 currently trending games.

Plays

Request recorded plays either by game or by user.

Search

Search for a game, returning everything that matches the search. Also includes a search_exact function that will only return exact name matches.

Thread

Retrieve threads by ID.

User

Request user information by their username.

Known issues

In the fields that return HTML, such as descriptions, HTML escape sequences are used. However UTF-8 code points are used, which means for example for ü has been encoded as Ã¼ but this decodes to Ã¼. Sorry Hans im GluÃ¼ck!

Formatting

Some rustfmt options used are nightly only. So to format run cargo +nightly fmt

arnak 0.7.0