An easy way to retrieve information through a Discord bot.
- Clone the repository and access it
git clone https://github.com/himea-io/discord-rest.git && cd discord-rest
. - Set your discord bot token and the server port (default 3001) in the
.env
file. - Type
npm install
. - Type
npm start
. - Enjoy your stuff!
Route | Description | Format |
---|---|---|
api/v1/users |
Display all the users known by the bot (users and bots). | JSON |
api/v1/users/bot |
Display all the bots known by the bot. | JSON |
api/v1/users/user |
Display all the users known by the bot. | JSON |
api/v1/user/{id} |
Display a user's information. | JSON |
api/v1/user/{id}/username |
Display a user's username. | RAW |
api/v1/user/{id}/discriminator |
Display a user's discriminator. | RAW |
api/v1/guilds |
Display all the guilds of the bot. | JSON |
api/v1/guild/{id} |
Display a guild's information. | JSON |
api/v1/guild/{id}/{user} |
Display a member of a guild's information (nickname, joinedAt...) | JSON |
api/v1/guild/{id}/{user}/nickname |
Display a member's of a guild nickname. | RAW |
See this in action at : https://himea-restapi.herokuapp.com/api/v1