Models API Reference#

class ResourceRating(count: int, rating: int)[source]#

Bases: APIObjectBase

Rating of bot/server

count: int#: Number of ratings

rating: int#: Rating (from 1 to 5)

classmethod from_dict(data: dict)[source]#

Generate a ResourceRating from the given data.

Parameters:: data (dict) – The dictionary to convert into a ResourceRating.

class ResourceUp(id: str, expires: datetime)[source]#

Bases: APIObjectBase

Information about bump (bot/server)

id: str#: Bump’s id

expires: datetime#: Expiration date. (ATTENTION! When using to_dict(), the data may not correspond to the actual data due to the peculiarities of the datetime module)

classmethod from_dict(data: dict)[source]#

Generate a ResourceUp from the given data.

Parameters:: data (dict) – The dictionary to convert into a ResourceUp.

Enums#

class BotLibrary(value)[source]#

Bases: IntEnum

The library that the bot is based on

DISCORD4J = 1#: Discord4j

DISCORDCR = 2#: Discordcr

DISCORDGO = 3#: DiscordGO

DISCORDDOO = 4#: Discordoo

DSHARPPLUS = 5#: DSharpPlus

DISCORDJS = 6#: Discord.js

DISCORDNET = 7#: Discord.Net

DISCORDPY = 8#: discord.py

ERIS = 9#: eris

JAVACORD = 10#: JavaCord

JDA = 11#: JDA

OTHER = 12#: Other

NONE = 0#: Bot’s library doesn’t specified

class BotTag(value)[source]#

Bases: IntEnum

Tags of the bot

MODERATION = 0#: Moderation

BOT = 1#: Bot

UTILITIES = 2#: Utilities

ENTERTAINMENT = 3#: Entertainment

MUSIC = 4#: Music

ECONOMY = 5#: Economy

LOGS = 6#: Logs

LEVELS = 7#: Levels

NSFW(18+) = 8#: NSFW (18+)

SETTINGS = 9#: Settings

ROLE_PLAY = 10#: Role-Play

MEMES = 11#: Memes

GAMES = 12#: Games

AI = 13#: AI

class ServerTag(value)[source]#

Bases: IntEnum

Tags of the server

SPEAKING = 130#: Speaking

FUN = 131#: Fun

GAMES = 132#: Games

CINEMA = 133#: Cinema

ANIME = 134#: Anime

ART = 135#: Art

CODING = 136#: Coding

MUSIC = 137#: Music

ADULT = 138#: 18+

ROLEPLAY = 139#: Role-Play

HUMOUR = 140#: Humour

GENSHIN = 160#: Genshin

MINECRAFT = 161#: Minecraft

GTA = 162#: GTA

CS = 163#: CS

DOTA = 164#: Dota

AMONG_US = 165#: Among Us

FORTNITE = 166#: Fortnite

BRAWL_STARS = 167#: Brawl Stars

class ResourceStatus(value)[source]#

Bases: IntEnum

Status of the project on monitoring

HIDDEN = 0#: is hidden

PUBLIC = 1#: is public

BANNED = 2#: is banned

PENDING = 3#: is pending

Bots#

class ResourceBot(id: str, name: str, short_description: str, description: str, avatar: str | None, short_link: str | None, standart_banner_id: int, invite_link: str, premium_active: bool, premium_splash_url: str | None, premium_auto_fetch: bool | None, premium_banner_url: str | None, owner: str, status: ResourceStatus, ratings: List[ResourceRating], prefix: str, discriminator: str, created_date: datetime, support_server_invite_link: str | None, library: BotLibrary | None, guilds: int | None, shards: int | None, members: int | None, website: str | None, tags: List[BotTag], up_count: int, ups: List[ResourceUp], developers: List[PartialUser])[source]#

Bases: APIObjectBase

Bot published on BotiCord

Warning

The result of the reverse conversion (.to_dict()) may not match the actual data.

id: str#: ID of the bot

name: str#: Name of the bot

short_description: str#: Short description of the bot

description: str#: Description of the bot

avatar: str | None#: Avatar of the bot

short_link: str | None#: Short link to the bot’s page

standart_banner_id: int#: Server’s standart banner ID

invite_link: str#: Invite link

premium_active: bool#: Is premium status active? (True/False)

premium_splash_url: str | None#: Link to the splash

premium_auto_fetch: bool | None#: Is auto-fetch enabled? (True/False)

premium_banner_url: str | None#: Premium banner URL

owner: str#: Owner of the bot

status: ResourceStatus#: Status of the bot

ratings: List[ResourceRating]#: Bot’s ratings

prefix: str#: Prefix of the bot

discriminator: str#: Bot’s discriminator

created_date: datetime#: Date when the bot was published

support_server_invite_link: str | None#: Link to the support server

library: BotLibrary | None#: The library that the bot is based on

guilds: int | None#: Number of guilds

shards: int | None#: Number of shards

members: int | None#: Number of members

website: str | None#: Link to bot’s website

tags: List[BotTag]#: List of bot tags

up_count: int#: Number of ups

ups: List[ResourceUp]#: List of bot’s ups

developers: List[PartialUser]#: List of bot’s developers

classmethod from_dict(data: dict)[source]#

Generate a ResourceBot from the given data.

Parameters:: data (dict) – The dictionary to convert into a ResourceBot.

Servers#

class ResourceServer(id: str, name: str, short_description: str, description: str, avatar: str | None, short_link: str | None, invite_link: str, premium_active: bool, premium_auto_fetch: bool | None, premium_banner_url: str | None, premium_splash_url: str | None, standart_banner_id: int, owner: str, status: ResourceStatus, ratings: List[ResourceRating], created_date: datetime, members: int | None, website: str | None, tags: List[ServerTag], moderators: List[PartialUser], up_count: int, ups: ResourceUp | None)[source]#

Bases: APIObjectBase

Information about server from BotiCord.

Warning

The result of the reverse conversion (.to_dict()) may not match the actual data.

id: str#: Server’s ID

name: str#: Server’s name

short_description: str#: Server’s short description

description: str#: Server’s description

avatar: str | None#: Server’s avatar

short_link: str | None#: Server’s short link

invite_link: str#: Server’s invite link

premium_active: bool#: Server’s premium state

premium_auto_fetch: bool | None#: Server’s premium auto fetch state

premium_banner_url: str | None#: Server’s premium banner URL

premium_splash_url: str | None#: Server’s premium splash URL

standart_banner_id: int#: Server’s standart banner ID

owner: str#: Server’s owner ID

status: ResourceStatus#: Server’s status

ratings: List[ResourceRating]#: Server’s ratings

created_date: datetime#: Server’s creation time

members: int | None#: Server’s members count

website: str | None#: Server’s website

tags: List[ServerTag]#: Server’s tags

moderators: List[PartialUser]#: Server’s moderators

up_count: int#: Server’s up count

ups: ResourceUp | None#: Server’s ups

classmethod from_dict(data: dict)[source]#

Generate a ResourceServer from the given data.

Parameters:: data (dict) – The dictionary to convert into a ResourceServer.

Users#

Bases: APIObjectBase

Links of the userk

vk: str | None#: vk.com

telegram: str | None#: t.me

donate: str | None#: Donate

git: str | None#: Link to git of the user

custom: str | None#: Custom link

classmethod from_dict(data: dict)[source]#

Generate a UserLinks from the given data.

Parameters:: data (dict) – The dictionary to convert into a UserLinks.

class UserBadge(id: int, name: str, asset_url: str)[source]#

Bases: APIObjectBase

Information about user’s profile badge

id: int#: Badge’s ID

name: str#: Badge’s name

asset_url: str#: Badge’s icon URL

classmethod from_dict(data: dict)[source]#

Generate a UserBadge from the given data.

Parameters:: data (dict) – The dictionary to convert into a UserBadge.

Bases: APIObjectBase

Partial user from BotiCord.

username: str#: Username

discriminator: str#: Discriminator

avatar: str | None#: Avatar of the user

id: str#: Id of the user

socials: UserLinks#: Links of the user

description: str | None#: Description of the user

short_description: str | None#: Short description of the user

status: str | None#: Status of the user

short_domain: str | None#: Short domain

classmethod from_dict(data: dict)[source]#

Generate a PartialUser from the given data.

Parameters:: data (dict) – The dictionary to convert into a PartialUser.

class UserProfile(username: str, discriminator: str, avatar: str | None, id: str, socials: UserLinks, description: str | None, short_description: str | None, status: str | None, short_domain: str | None, badges: List[UserBadge], bots: List[ResourceBot], servers: List[ResourceServer])[source]#

Bases: PartialUser

Information about user’s profile from BotiCord.’

username: str#: Username

discriminator: str#: Discriminator

avatar: str | None#: Avatar of the user

id: str#: Id of the user

socials: UserLinks#: Links of the user

description: str | None#: Description of the user

short_description: str | None#: Short description of the user

status: str | None#: Status of the user

short_domain: str | None#: Short domain

badges: List[UserBadge]#: User’s badges list.

bots: List[ResourceBot]#: User’s bots list

servers: List[ResourceServer]#: User’s servers list

classmethod from_dict(data: dict)[source]#

Generate a UserProfile from the given data.

Parameters:: data (dict) – The dictionary to convert into a UserProfile.

MeiliSearch#

class MeiliIndexedBot(id: str, name: str, short_description: str, description: str, avatar: str | None, invite: str, premium_active: bool, premium_banner: str | None, banner: int, rating: int, discriminator: str, library: BotLibrary | None, guilds: int | None, shards: int | None, members: int | None, tags: List[BotTag], ups: int)[source]#

Bases: APIObjectBase

Bot found on BotiCord

Warning

The result of the reverse conversion (.to_dict()) may not match the actual data.

id: str#: ID of the bot

name: str#: Name of the bot

short_description: str#: Short description of the bot

description: str#: Description of the bot

avatar: str | None#: Avatar of the bot

invite: str#: Invite link

premium_active: bool#: Is premium status active? (True/False)

premium_banner: str | None#: Premium banner URL

banner: int#: Standart banner

rating: int#: Bot’s rating

discriminator: str#: Bot’s discriminator

library: BotLibrary | None#: The library that the bot is based on

guilds: int | None#: Number of guilds

shards: int | None#: Number of shards

members: int | None#: Number of members

tags: List[BotTag]#: List of bot tags

ups: int#: List of bot’s ups

classmethod from_dict(data: dict)[source]#

Generate a MeiliIndexedBot from the given data.

Parameters:: data (dict) – The dictionary to convert into a MeiliIndexedBot.

class MeiliIndexedServer(id: str, name: str, short_description: str, description: str, avatar: str | None, invite: str, premium_active: bool, premium_banner: str | None, banner: int, discord_banner: str | None, rating: int, members: int | None, tags: List[ServerTag], ups: int)[source]#

Bases: APIObjectBase

Server found on BotiCord

Warning

The result of the reverse conversion (.to_dict()) may not match the actual data.

id: str#: ID of the server

name: str#: Name of the server

short_description: str#: Short description of the server

description: str#: Description of the server

avatar: str | None#: Avatar of the server

invite: str#: Invite link

premium_active: bool#: Is premium status active? (True/False)

premium_banner: str | None#: Premium banner URL

banner: int#: Standart banner

discord_banner: str | None#: Discord banner URL

rating: int#: Server’s rating

members: int | None#: Number of members

tags: List[ServerTag]#: List of server tags

ups: int#: List of server’s ups

classmethod from_dict(data: dict)[source]#

Generate a MeiliIndexedServer from the given data.

Parameters:: data (dict) – The dictionary to convert into a MeiliIndexedServer.

class MeiliIndexedComment(id: str, author: str, rating: int, content: str, resource: str, created: datetime, mod_reply: str | None)[source]#

Bases: APIObjectBase

Comment found on BotiCord

id: str#: ID of the comment

author: str#: Id of the author of the comment

rating: int#: Comment’s rating

content: str#: Content of the comment

resource: str#: Id of the resource

created: datetime#: When the comment was created

mod_reply: str | None#: Reply to the comment

classmethod from_dict(data: dict)[source]#

Generate a MeiliIndexedComment from the given data.

Parameters:: data (dict) – The dictionary to convert into a MeiliIndexedComment.