Struct topgg::Topgg

pub struct Topgg { /* fields omitted */ }

This is the top.gg API client. It houses the functions needed to interact with their API.

Implementations

impl Topgg

pub fn new(bot_id: u64, token: String) -> Topgg

Returns a new client.

Arguments

• bot_id - The ID of your bot
• token - The top.gg token for that (or another valid) bot

Examples

let client = topgg::Topgg::new(bot_id, token);
// Do stuff with the client
let votes = client.votes().await.unwrap();

pub async fn my_bot(&self) -> Option<Bot>

A shortcut for getting the botinfo for your own bot.

Examples

let bot_info = client.my_bot().await.unwrap();

pub async fn bot(&self, bot_id: u64) -> Option<Bot>

Gets the info for a bot given an ID. To get the info for your own bot client.my_bot() can be used as a shortcut.

Examples

let bot_info = lient.bot(668701133069352961).await.unwrap();

pub async fn user(&self, user_id: u64) -> Option<User>

Gets the info for a user.

Examples

client.user(195512978634833920).await.unwrap();

pub async fn my_votes(&self) -> Option<Vec<u64>>

A shortcut for getting the votes for the bot that created the client.

Examples

let votes = client.my_votes().await.unwrap();

pub async fn votes(&self, bot_id: u64) -> Option<Vec<u64>>

Gets the user IDs of all the users that have voted on the bot_id.

Examples

client.votes(668701133069352961).await.unwrap();

pub async fn voted_for_me(&self, user_id: u64) -> Option<bool>

A shortcut for checking if a user has voted for your own bot.

Examples

let voted = client.voted_for_me(195512978634833920).await.unwrap();

pub async fn voted(&self, bot_id: u64, user_id: u64) -> Option<bool>

Checks if a user has voted for the bot or not. Returns true if they have, false if they have not.

Examples

let voted = client.voted(668701133069352961, 195512978634833920)
    .await
    .unwrap();

pub async fn my_bot_stats(&self) -> Option<BotStats>

A shortcut for getting the bot stats of the bot that created the client.

Examples

let stats = client.my_bot_stats().await.unwrap();

pub async fn get_bot_stats(&self, bot_id: u64) -> Option<BotStats>

Gets the 'stats' of the bot, this includes the server count, shard count, and shards (servers per shard).

Examples

client.get_bot_stats(Some(668701133069352961)).await.unwrap();

pub async fn post_bot_stats(
    &self,
    server_count: Option<u32>,
    shards: Option<Vec<u32>>,
    shard_id: Option<u32>,
    shard_count: Option<u32>
) -> Result<Response, Error>

This posts the stats for your bot. Useful if you want to update the server count on your top.gg bot page. You can omit from having a server_count if you use shards where it is a Vec of the number of servers per shard. shard_id is only applicable if you use sever_count and it tells top.gg the number of servers for that indexed shard.

Examples

client.post_bot_stats(None, Some(vec![142, 532, 304]), None, None).await;
client.post_bot_stats(Some(142), None, Some(0), None).await;
client.post_bot_stats(Some(978), None, None, Some(3)).await;