Models API Reference¶

class topgg.types.StatsWrapper(guild_count: int, shard_count: Union[int, NoneType] = None, shard_id: Union[int, NoneType] = None)[source]¶

guild_count: int¶: The guild count.

shard_count: Optional[int] = None¶: The shard count.

shard_id: Optional[int] = None¶: The shard ID the guild count belongs to.

class topgg.types.WidgetOptions(id: Optional[int] = None, format: Optional[str] = None, type: Optional[str] = None, noavatar: bool = False, colors: Optional[Dict[str, int]] = None, colours: Optional[Dict[str, int]] = None)[source]¶

Model that represents widget options that are passed to Top.gg widget URL generated via DBLClient.generate_widget().

colors: Dict[str, int]¶: A dictionary consisting of a parameter as a key and HEX color (type int) as value. color will be appended to the key in case it doesn’t end with color.

format: str¶: Format to apply to the widget. Must be either png and svg. Defaults to png.

id: Optional[int]¶: ID of a bot to generate the widget for. Must resolve to an ID of a listed bot when converted to a string.

noavatar: bool¶: Indicates whether to exclude the bot’s avatar from short widgets. Must be of type bool. Defaults to False.

type: str¶: Type of a short widget (status, servers, upvotes, and owner). For large widget, must be an empty string.

class topgg.types.DataDict(**kwargs: topgg.types.VT)[source]¶

Base class used to represent received data from the API.

Every data model subclasses this class.

clear() → None. Remove all items from D.¶

copy() → a shallow copy of D¶

fromkeys(value=None, /)¶: Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)¶: Return the value for key if key is in the dictionary, else default.

items() → a set-like object providing a view on D's items¶

keys() → a set-like object providing a view on D's keys¶

pop(k[, d]) → v, remove specified key and return the corresponding value.¶: If key is not found, d is returned if given, otherwise KeyError is raised

popitem()¶

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)¶

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None. Update D from dict/iterable E and F.¶: If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → an object providing a view on D's values¶

class topgg.types.BotData(**kwargs: Any)[source]¶

Bases: topgg.types.DataDict[str, Any]

Model that contains information about a listed bot on top.gg. The data this model contains can be found here.

avatar: Optional[str]¶: The avatar hash of the bot.

certified_bot: bool¶: Whether or not the bot is certified.

date: datetime.datetime¶: The time the bot was added.

def_avatar: str¶: The avatar hash of the bot’s default avatar.

discriminator: str¶: The discriminator of the bot.

donatebotguildid: int¶: The guild ID for the donatebot setup.

github: Optional[str]¶: The GitHub URL of the repo of the bot.

guilds: List[int]¶: The guilds the bot is in.

id: int¶: The ID of the bot.

invite: Optional[str]¶: The invite URL of the bot.

longdesc: Optional[str]¶: The long description of the bot.

monthly_points: int¶: The amount of the votes the bot has this month.

owners: List[int]¶: The IDs of the owners of the bot.

points: int¶: The amount of the votes the bot has.

prefix: str¶: The prefix of the bot.

shortdesc: str¶: The brief description of the bot.

support: Optional[str]¶: The invite code of the bot’s support server.

tags: List[str]¶: The tags the bot has.

username: str¶: The username of the bot.

vanity: Optional[str]¶: The vanity URL of the bot.

website: Optional[str]¶: The website of the bot.

class topgg.types.BotStatsData(**kwargs: Any)[source]¶

Bases: topgg.types.DataDict[str, Any]

Model that contains information about a listed bot’s guild and shard count.

server_count: Optional[int]¶: The amount of servers the bot is in.

shard_count: Optional[int]¶: The amount of shards a bot has.

shards: List[int]¶: The amount of servers the bot is in per shard.

class topgg.types.BriefUserData(**kwargs: Any)[source]¶

Bases: topgg.types.DataDict[str, Any]

Model that contains brief information about a Top.gg user.

avatar: str¶: The Discord avatar URL of the user.

id: int¶: The Discord ID of the user.

username: str¶: The Discord username of the user.

class topgg.types.UserData(**kwargs: Any)[source]¶

Bases: topgg.types.DataDict[str, Any]

Model that contains information about a top.gg user. The data this model contains can be found here.

admin: bool¶: Whether or not the user is a Top.gg admin.

certified_dev: bool¶: Whether or not the user is a certified dev.

color: str¶: The custom hex color of the user.

discriminator: str¶: The discriminator of the user.

id: int¶: The ID of the user.

mod: bool¶: Whether or not the user is a Top.gg mod.

social: topgg.types.SocialData¶: The social data of the user.

supporter: bool¶: Whether or not the user is a supporter.

username: str¶: The username of the user.

web_mod: bool¶: Whether or not the user is a Top.gg web mod.

class topgg.types.SocialData(**kwargs: topgg.types.VT)[source]¶

Bases: topgg.types.DataDict[str, str]

Model that contains social information about a top.gg user.

github: str¶: The GitHub username of the user.

instagram: str¶: The Instagram username of the user.

reddit: str¶: The Reddit username of the user.

twitter: str¶: The Twitter username of the user.

youtube: str¶: The YouTube channel ID of the user.

class topgg.types.VoteDataDict(**kwargs: Any)[source]¶

Bases: topgg.types.DataDict[str, Any]

Base model that represents received information from Top.gg via webhooks.

query: topgg.types.DataDict¶: Query parameters in DataDict.

type: str¶: Type of the action (upvote or test).

user: int¶: ID of the voter.

class topgg.types.BotVoteData(**kwargs: Any)[source]¶

Bases: topgg.types.VoteDataDict

Model that contains information about a bot vote.

bot: int¶: ID of the bot the user voted for.

is_weekend: bool¶: Boolean value indicating whether the action was done on a weekend.

class topgg.types.GuildVoteData(**kwargs: Any)[source]¶

Bases: topgg.types.VoteDataDict

Model that contains information about a guild vote.

guild: int¶: ID of the guild the user voted for.