Skip to content
This repository was archived by the owner on Jun 27, 2020. It is now read-only.

himea-io/discord-rest

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

discord-rest

An easy way to retrieve information through a Discord bot.

Setup

  1. Clone the repository and access it git clone https://github.com/himea-io/discord-rest.git && cd discord-rest.
  2. Set your discord bot token and the server port (default 3001) in the .env file.
  3. Type npm install.
  4. Type npm start.
  5. Enjoy your stuff!

Routes descriptions

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

Demo

See this in action at : https://himea-restapi.herokuapp.com/api/v1

About

An easy way to retrieve information through a Discord bot.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published