BLAPI - the BotListAPI

BLAPI is a package to handle posting your discord bot stats to botlists. Now typed and ready to be used in your Typescript powered bots!

It's intended to be used with discord.js v12, though you can also manually post your stats.

BLAPI fully supports external and discord.js internal sharding with and without the use of the BotBlock API.

Installation

NPM (recommended)

npm i blapi

Yarn

yarn add blapi

Usage

The list of all supported bot lists and their respective names for the apiKeys object are listed below

Import the lib via ES6 or commonJS modules

// ES6
import * as blapi from "blapi";
// or
import { handle } from "blapi"; // Just the functions you want to use
// or commonJS
const blapi = require("blapi");

With discord.js

import Discord from "discord.js";

const bot = new Discord.Client();

// Post to the APIs every 60 minutes; you can leave out the repeat delay as it defaults to 30
// If the interval is below 3 minutes BLAPI will not use the BotBlock API because of ratelimits
blapi.handle(bot, apiKeys, 60);

Manually, without need of Discord libraries

// If you want to post sharddata you can add the optional parameters
// shardID and shardCount should both be integers
// shardsArray should be an integer array containing the guildcounts of the respective shards
blapi.manualPost(guildCount, botID, apiKeys[, shardID, shardCount[, shardsArray]]);

Logging Options

// Use this to get more detailed logging when posting
// Errors will always be logged
blapi.setLogging({
  extended: true
});

// If you have your own logger that you want to use pass it to BLAPI like so (the variable "log" in this example)
// !Important: The logger needs to export the following methods: log.info(), log.warn() and log.error()
blapi.setLogging({
  extended: true,
  logger: log
})

// If you want to pass in only your custom logger but dont want extended logging to be enabled you would do:
blapi.setLogging({
  logger: log
})

Turn on extended logging

// Use this to get more detailed logging when posting
// Errors will always be logged
blapi.setLogging(true);

Turn off the use of the BotBlock API

// Use this to turn off BotBlock usage
// By default it is set to true
blapi.setBotblock(false);

apiKeys

The JSON object which includes all the API keys should look like this:

{
  "bot list domain": "API key for that bot list",
  "bot list domain": "API key for that bot list"
}

an example would be:

{
  "bots.ondiscord.xyz": "dsag38_auth_token_fda6gs",
  "discordbots.group": "qos56a_auth_token_gfd8g6"
}

Lists

A list of supported bot lists can be found here. Supported legacy Ids can be found here.

BLAPI will look for new additions on startup via the BotBlock API. This data is being updated internally on a daily basis.

If at any time you find other bot lists have added an API to post your guildcount, let us know on this repo or by contacting botblock#1 on Discord.

Credit

All the people who helped making BLAPI are listed in AUTHORS

By default we use the BotBlock API to fetch and post.

MeerBiene/BLAPI