Struct Api 

pub struct Api { /* private fields */ }

Top level API handler.

All network calls are handled through here.

Implementations

impl Api

pub fn new<S: Into<String>>(key: S) -> Self

Create a new wrapper with a personal API key.

Ideally should be checked with Api::validate right after:

Examples

let api = Api::new("here is my custom key");
assert!(api.validate().await.is_ok());

impl Api

User related methods.

Status

• GET v1/users/validate
• GET v1/user/tracked_mods
• POST v1/user/tracked_mods
• DELETE v1/user/tracked_mods
• GET v1/user/endorsements

pub async fn validate(&self) -> Result<Validate, ValidateError>

Validate API key and retrieve user details.

Examples

let api = Api::new("...");
// I am a premium user!
assert!(api.validate().await?.is_premium());

pub async fn tracked_mods(&self) -> Result<TrackedModsRaw, ValidateError>

Get a list of the user’s tracked mods.

Notes

Consider converting to TrackedMods.

pub async fn track_mod<T: Into<u64>>( &self, game: &str, id: T, ) -> Result<PostModStatus, TrackModError>

Track a mod based on a u64 mod ID.

pub async fn untrack_mod<T: Into<ModId>>( &self, game: &str, id: T, ) -> Result<(), DeleteModError>

Untrack a mod.

Notes

This function takes in a ModId, not a u64 because it is assumed that (unlike Api::track_mod) the caller knows of a valid mod ID.

pub async fn endorsements(&self) -> Result<Endorsements, ValidateError>

Get a list of mods the user has endorsed.

impl Api

Mod related methods.

• GET v1/games/{game_domain_name}/mods/updated
• GET v1/games/{game_domain_name}/mods/{mod_id}/changelogs
• GET v1/games/{game_domain_name}/mods/latest_added
• GET v1/games/{game_domain_name}/mods/latest_updated
• GET v1/games/{game_domain_name}/mods/trending
• GET v1/games/{game_domain_name}/mods/{id}
• GET v1/games/{game_domain_name}/mods/md5_search/{md5_hash}
• POST v1/games/{game_domain_name}/mods/{id}/endorse
• POST v1/games/{game_domain_name}/mods/{id}/abstain

pub async fn updated_during( &self, game: &str, time: TimePeriod, ) -> Result<Vec<ModUpdated>, GameModError>

Get a list of mods updated within a timeframe.

pub async fn changelogs<T: Into<ModId>>( &self, game: &str, id: T, ) -> Result<Changelog, GameModError>

Get changelogs for a mod.

pub async fn mod_info<T: Into<ModId>>( &self, game: &str, id: T, ) -> Result<GameMod, GameModError>

Get specific mod information.

impl Api

Game related methods.

• GET v1/games
• GET v1/games/{game_domain_name}

pub async fn games(&self) -> Result<Vec<GameId>, GameModError>

Get a list of all games tracked by NexusMods.

pub async fn game(&self, game: &str) -> Result<GameId, GameModError>

Get information about a single game.

impl Api

Mod file related methods.

• GET v1/games/{game_domain_name}/mods/{mod_id}/files
• GET v1/games/{game_domain_name}/mods/{mod_id}/files/{file_id}
• GET v1/games/{game_domain_name}/mods/{mod_id}/files/{id}/download_link

pub async fn mod_files<S: Into<ModId>>( &self, game: &str, mod_id: S, category: Option<CategoryName>, ) -> Result<ModFiles, GameModError>

Based on a game and a ModId, get data about the download files the mod provides.

pub async fn mod_file<S: Into<ModId>>( &self, game: &str, mod_id: S, file_id: u64, ) -> Result<ModFile, GameModError>