TopCord Documentation

Bots

This is the page for TopCord's Rest API.

Endpoints

List Bots

GET /bots
  • Authentication: Not Required

Lists every bot that is added to the list

Response

FieldTypeDescription
N/ABot[]The bots structure

Get information about a specific bot

GET /bot/:id
  • Authentication: Not Required

Lists information about a specific bot

Response

The Bot structure or a failure response

Set bot statisctics

POST /bot/:id/stats
  • Authentication: Required

Post body

FieldTypeDescriptionRequired
guildsnumberThe number of guilds the bot is inYes
shardsnumberThe number of shards the bot hasNo

Response

A success response or a failure response

Structure

Bot structure

FieldTypeDescription
ClientIDstringThe bots client ID
LibrarystringThe library the bot was made in
Ownersstring[]The owners of the bot
Tagsstring[]The bots tags
ShortDescriptionstringThe bots short description
WebsitestringThe bots website
CertifiedbooleanIf the bot is certified or not
Statisticsnumber[]The bots shard and guild count

Example bot structure

Example
1{
2 "ClientID": "275813801792634880",
3 "Library": "discord.js",
4 "Owners": [
5 "148359099782791168"
6 ],
7 "Tags": [
8 "Moderation",
9 "Utility"
10 ],
11 "ShortDescription": "Zira is a reaction role Discord bot that allows users to give themselves roles by reacting on messages with emojis/emotes.",
12 "Website": "https://zira.gg",
13 "SupportServer": "https://discord.gg/zira",
14 "Certified": true,
15 "Statistics": {
16 "Votes": 0,
17 "Servers": 0
18 }
19}

Success Responses

Responses
1// 200
2{
3 "message": "Bot Updated"
4}

Failure Responses

Responses
1// 404
2{
3 "message": "Not Found"
4}
5
6// 401
7{
8 "message": "Unauthorized or Incorrect Token"
9}
10
11// 422
12{
13 "message": "Incorrect Parameter"
14}
Edit this page on GitHub