API Documentation

This is the documentation to VitalList's API.






GET Bot Information

Returns all information on a bot.


GET /api/bots/:id


PropertyTypeDescription
idStringThe ID of the targeted bot.
usernameStringThe username of the targeted bot.
discriminatorStringThe discriminator of the targeted bot.
avatarStringThe avatar URL of the targeted bot.
prefixStringThe prefix of the targeted bot.
ownerStringThe ID of the targeted bot's owner.
ownerTagStringThe tag of the targeted bot's owner.
tagsArrayAn array of the targeted bot's tags.
viewsIntergerThe amount of views the targeted bot's page has gotten.
submittedOnStringThe date the targeted bot was submitted to VitalList.
approvedOnStringThe date the targeted bot was approved on VitalList.
shortDescriptionStringThe short description of the targeted bot on VitalList.
descriptionStringThe description of the targeted bot on VitalList.
shardsStringThe number of shards the targeted bot has.
serversIntergerThe number of servers the targeted bot has.
votesIntergerThe number of vots the targeted bot has on VitalList.
inviteStringThe invite of the targeted bot.
websiteStringThe website of the targeted bot.
githubStringThe github of the targeted bot.
supportStringThe support server of the targeted bot.



POST Bot Stats

Posts your bot's server and shard count.


POST /api/bots/:id


HeaderTypeDescription
authorizationStringThe API Key for the targeted bot.
server_countIntergerThe server count for the targeted bot.
shard_countIntergerThe shard count for the targeted bot.


GET Bot Votes

Get all votes of a bot on VitalList.


GET /api/bots/:id/votes


PropertyTypeDescription
userStringThe user ID who voted for the bot.
currentIntergerThe date the user voted.
nextIntergerThe time unitl they can vote again.


Check Vote

Check if a user voted for your bot.


GET /api/bots/:id/voted/?user=userid


PropertyTypeDescription
voteBooleanIf the user voted or not.
currentIntergerThe date the user voted.
nextIntergerThe time unitl they can vote again.


GET Server Information

Returns all information on a server.


GET /api/servers/:id


PropertyTypeDescription
nameStringThe name of the targeted server.
idStringThe ID of the targeted server.
membersIntergerThe member count of the targeted server.
iconStringThe icon URL of the targeted server.
inviteStringThe invite URL of the targeted server.
submittedOnStringThe submitted date of the targeted server.
websiteStringThe website URL of the targeted server.
ownerStringThe owner ID of the targeted server.
ownerTagStringThe owner tag of the targeted server.
tagsArrayAll of the tags of the targeted server.
bumpDateThe latest bump date of the targeted server.
bumpsIntergerThe number of bumps of the targeted server.
viewsIntergerThe number of views of the targeted server.
votesIntergerThe number of votes of the targeted server.
shortDescStringThe short description of the targeted server.
descriptionStringThe description of the targeted server.


VitalList NPM Package

Find our NPM Package here to learn how to interact with our API.