API Documentation

This is the documentation to RevoltList's API.

GET Bot Information

Returns all information on a bot.

GET /api/v1/bots/:id/

Property	Type	Description
id	String	The ID of the targeted bot.
username	String	The username of the targeted bot.
avatar	String	The avatar URL of the targeted bot.
prefix	String	The prefix of the targeted bot.
owners	Array	An array of the targeted bot's owner IDs.
tags	Array	An array of the targeted bot's tags.
submittedOn	String	The date the targeted bot was submitted to RevoltList.
shortDescription	String	The short description of the targeted bot on RevoltList.
description	String	The description of the targeted bot on RevoltList.
servers	Integer	The number of servers the targeted bot has.
totalvotes	Integer	The total number of vots the targeted bot has on RevoltList.
monthlyvotes	Integer	The monthly number of vots the targeted bot has on RevoltList.
invite	String	The invite of the targeted bot.
website	String	The website of the targeted bot.
github	String	The github of the targeted bot.
library	String	The library of the targeted bot.
support	String	The support server of the targeted bot.

POST Bot Stats

Posts your bot's server and shard count.

POST /api/v1/bots/stats

Header	Type	Description
authorization	String	The API Key for the targeted bot.
servers	Integer	The server count for the targeted bot.

GET Bot Votes

Get all votes of a bot on RevoltList.

GET /api/v1/bots/:id/votes

Property	Type	Description
user	String	The user ID who voted for the bot.
current	Integer	The date the user voted.
next	Integer	The time until they can vote again.

Check Vote

Check if a user voted for your bot.

GET /api/v1/bots/:id/votes?user=:userID

Property	Type	Description
vote	Boolean	If the user voted or not.
current	Integer	The date the user voted.
next	Integer	The time until they can vote again.

GET Server Information

Returns all information on a server.

GET /api/v1/servers/:id

RevoltList NPM Package

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