Client API Reference#
BoticordClient#
- class BoticordClient(token: str | None = None, version: int = 3)[source]#
Bases:
object
Represents a client that can be used to interact with the BotiCord API.
Note
Remember that every http method can return an http exception.
- Parameters:
token (
str
) – Your bot’s Boticord API Token.version (
int
) – BotiCord API version (Default: 3)
- await get_bot_info(bot_id: str | int) ResourceBot [source]#
Gets information about specified bot.
- Parameters:
bot_id (Union[
str
,int
]) – Id of the bot- Returns:
ResourceBot object.
- Return type:
- await post_bot_stats(bot_id: str | int, *, servers: int | None = None, shards: int | None = None, users: int | None = None) ResourceBot [source]#
Post Bot’s stats.
Warning
None of the values must be equal to 0. Specify None instead of 0.
- Parameters:
bot_id (Union[
str
,int
]) – Id of the bot to post stats of.servers (Optional[
int
]) – Bot’s servers countshards (Optional[
int
]) – Bot’s shards countusers (Optional[
int
]) – Bot’s users count
- Returns:
ResourceBot object.
- Return type:
- await get_server_info(server_id: str | int) ResourceServer [source]#
Gets information about specified server.
- Parameters:
server_id (Union[
str
,int
]) – Id of the server- Returns:
ResourceServer object.
- Return type:
- await get_user_info(user_id: str | int) UserProfile [source]#
Gets information about specified user.
- Parameters:
user_id (Union[
str
,int
]) – Id of the user- Returns:
UserProfile object.
- Return type:
- await search_for_bots(**kwargs) List[MeiliIndexedBot] [source]#
Search for bots on BotiCord.
Note
You can find every keyword argument here.
- Returns:
List of found bots
- Return type:
List[
MeiliIndexedBot
]
- await search_for_servers(**kwargs) List[MeiliIndexedServer] [source]#
Search for servers on BotiCord.
Note
You can find every keyword argument here.
- Returns:
List of found servers
- Return type:
List[
MeiliIndexedServer
]
- await search_for_comments(**kwargs) List[MeiliIndexedComment] [source]#
Search for comments on BotiCord.
Note
You can find every keyword argument here.
- Returns:
List of found comments
- Return type:
List[
MeiliIndexedComment
]