stacklist.js v0.0.7
StackList NPM Package
The offical Node SDK to interact with StackList's API. (StackList is not released yet)
Version 0.0.6
This is just a testing version, the base url will be localhost instead of Stacklist URL. Please install the 0.0.7 version for it to work again :D // Stacksyz(Owner of StackList and StackList.js NPM Package)
npm i stacklist.js
Getting Started
To post your bot's stats to Universe List, you will need a Discord client and the stacklist.js
package defined.
const { Client, Events, GatewayIntentBits } = require('discord.js');
const stackList = require('stacklist.js');
const client = new Client({ intents: [GatewayIntentBits.Guilds] });
POSTing bot's stats
First, define your Discord client, and then provide your StackList API Key found in your bot's edit page.
const Discord = require('discord.js');
const client = new Discord.Client();
const API_KEY = 'YOUR_API_KEY';
// Login to your bot
client.login('BOT_TOKEN')
// Post stats
client.on('ready', () => {
setInterval(async () => {
try {
await postStats(client, API_KEY);
} catch (error) {
console.error(`Failed to post stats: ${error}`);
}
}, 5 * 60 * 1000); // Posts every 5 minutes
});
Debug Mode
If you want to log the response message to the console, add true
as parameter.
await postStats(client, API_KEY, true);
GETing bot's info
Provide a Discord bot ID of a bot that is on StackList.
const botId = '123456789'; // Replace this with the ID of the bot.
universeList.fetchBot(botId)
.then((botData) => {
console.log(botData);
})
.catch((err) => {
console.error(err);
});
GETing server's info
Provide a Discord server ID of a server that is on StackList Servers.
const serverId = '123456789'; // Replace this with the ID of the server.
stackList.fetchServer(serverId)
.then((serverData) => {
console.log(serverData);
})
.catch((err) => {
console.error(err);
});
GETing bots's votes
Provide a Discord bot ID of a bot that is on StackList.
const botId = '123456789'; // Replace this with the ID of the bot.
stackList.fetchVotes(botId)
.then((votes) => {
console.log(votes);
})
.catch((err) => {
console.error(err);
});
Check Vote from user
Provide a Discord bot ID of a bot that is on StackList and a Discord user ID.
const botId = '123456789'; // Replace this with the ID of the bot.
const userId = '987654321'; // Replace this with the ID of the user.
stackList.checkVote(botId, userId)
.then((voteData) => {
console.log(voteData);
})
.catch((err) => {
console.error(err);
});
Credits
This API was originally created by Stacksyz.