Discord List App-API Documentation

Last updated 2 months ago

A simple way of communicating between Discord List App and node.js

discordlistapp-api

NPM Build Status Codacy Badge Greenkeeper badge

A simple way of communicating between Discord List App and node.js.

Client

To start the client do the following:

const discordlistapp = require('discorclistapp-api');
const discordlistclient = new discordlistapp.Client('YourTokenHere', 'YourBotIDHere');

get
getBot

discordlistclient
.getBot(id)
Used getting info on a certain bot.
Request
Response
Path Parameters
id
required
string
The ID of the bot.
200: OK
{
"avatar": "9c382b6bc6c76a6d0b83baa5362051e0",
"discriminator": "0473",
"id": "341980888239702017",
"invite": "https://discordapp.com/oauth2/authorize?client_id=341980888239702017&scope=bot&permissions=3533830",
"library": "discord.js",
"long_description": "Jennifer, the new girl on the block. With lots of features listed below\r\nFeatures:\r\nModeration:\r\n- Kicking\r\n- Banning\r\n- Moderation Log\r\n- Message Pruning\r\nFun:\r\n- Dice Rolling\r\n- Coin Flipping\r\n- 8ball\r\n- Crime Coefficient\r\n- ASCII faces\r\n- Coin Flipping\r\n- Movie & TV lookup!\r\nUtility:\r\n- Server Information\r\n- User Information Fetching w/ User Avatar Displaying\r\n- Role Information\r\n- UserRole lookup\r\n- Member Count\r\n\r\nAnd more!",
"name": "Jennifer",
"owner_id": "166228540214214657",
"owner_name": "Wistful__#9063",
"prefix": "j) or J) | @Jennifer",
"short_description": "ennifer, the new girl on the block. With multiple Moderation, Utility, Lookup, & Fun commands. (ITS NOT JUST A GIRL :D)",
"support_server": "https://discord.gg/0xxkiR1rO4zRsYLp",
"username": "Jennifer#0473",
"votes": 0,
"website": "https://hexaplexsoftware.ga/"
}

post
postGuildCount

discordlistclient
.postGuildCount(count)
Post your Server Count to Discord List App
Request
Response
Path Parameters
count
required
string
Guild Count.
Headers
Bot ID
required
string
From the Client Snowflake
Authorization
required
string
From the Client Snowflake
204: No Content

get
getVotes

discordlistclient
.getVotes()
Retrieves the users that have voted for a bot.
Request
Response
Headers
Bot ID
optional
string
From the Client Snowflake
Authorization
optional
string
From the Client Snowflake
200: OK
Data: {[0]: 66166172835385344}

get
getGuildCount

discordlistclient
.getGuildCount(id)
Retrieves the Guild Count of a bot
Request
Response
Path Parameters
ID
optional
string
The ID of the bot
200: OK
{"server_count": 500}

get
getAllBots

discordlistclient
.getAllBots()
Request
Response
200: OK
JSON Array