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
Field | Type | Description |
---|---|---|
N/A | Bot[] | 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
Field | Type | Description | Required |
---|---|---|---|
guilds | number | The number of guilds the bot is in | Yes |
shards | number | The number of shards the bot has | No |
Response
A success response or a failure response
Structure
Bot structure
Field | Type | Description |
---|---|---|
ClientID | string | The bots client ID |
Library | string | The library the bot was made in |
Owners | string[] | The owners of the bot |
Tags | string[] | The bots tags |
ShortDescription | string | The bots short description |
Website | string | The bots website |
Certified | boolean | If the bot is certified or not |
Statistics | number[] | 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": 018 }19}
Success Responses
Responses
1// 2002{3 "message": "Bot Updated"4}
Failure Responses
Responses
1// 4042{3 "message": "Not Found"4}56// 4017{8 "message": "Unauthorized or Incorrect Token"9}1011// 42212{13 "message": "Incorrect Parameter"14}