An official module for interacting with the top.gg API. 

An official module for interacting with the top.gg API

tonkku107

dblapi.js

  "description": "An official module for interacting with the discordbots.org API",

  "description": "An official module for interacting with the top.gg API",

    "test": "echo \"Error: no test specified\" && exit 1"

  "author": "Discord Bot List <support@discordbots.org> (https://discordbots.org)",

  "author": "Discord Bot List <support@top.gg> (https://top.gg)",

  "repository": "DiscordBotList/dblapi.js",

An official module for interacting with the discordbots.org API

Documentation can be found [here](https://discordbots.org/api/docs#jslib)

Documentation can be found [here](https://top.gg/api/docs#jslib)

### Example of posting server count with supported libraries (Discord.js and Eris)

const dbl = new DBL('Your discordbots.org token', client);

const dbl = new DBL('Your top.gg token', client);

### Example of using webhooks to receive vote updates

const dbl = new DBL(yourDBLTokenHere, { webhookPort: 5000, webhookAuth: 'password' });

  console.log(`Webhook running at http://${hook.hostname}:${hook.port}${hook.path}`);

  console.log(`User with ID ${vote.user} just voted!`);

    const lib = require.cache[require.resolve(library)];

    return lib && client instanceof lib.exports.Client;

const isASupportedLibrary = client => isLib('discord.js', client) || isLib('eris', client);

   * @param {string} token Your discordbots.org token for this bot.

   * @param {string} token Your top.gg token for this bot.

   * @param {Object} [options] Your DBLAPI options.

   * @param {number} [options.statsInterval=1800000] How often the autoposter should post stats in ms. May not be smaller than 900000 and defaults to 1800000.

   * @param {number} [options.webhookPort] The port to run the webhook on. Will activate webhook when set.

   * @param {string} [options.webhookAuth] The string for Authorization you set on the site for verification.

   * @param {string} [options.webhookPath='/dblwebhook'] The path for the webhook request.

   * @param {http.Server} [options.webhookServer] An existing http server to attach the webhook to.

   * @param {any} [client] Your Client instance, if present and supported it will auto update your stats every `options.statsInterval` ms.

    if (client && isASupportedLibrary(client)) {

      if (!this.options.statsInterval) this.options.statsInterval = 1800000;

      if (this.options.statsInterval < 900000) throw new Error('statsInterval may not be shorter than 900000 (15 minutes)');

       * Event that fires when the stats have been posted successfully by the autoposter

       * Event to notify that the autoposter post request failed

          .then(() => this.emit('posted'))

          .catch(e => this.emit('error', e));

            .then(() => this.emit('posted'))

            .catch(e => this.emit('error', e));

      console.error(`[dblapi.js autopost] The provided client is not supported. Please add an issue or pull request to the github repo https://github.com/DiscordBotList/dblapi.js`); // eslint-disable-line no-console

    if (this.options.webhookPort || this.options.webhookServer) {

      const DBLWebhook = require('./webhook');

      this.webhook = new DBLWebhook(this.options.webhookPort, this.options.webhookPath, this.options.webhookAuth, this.options.webhookServer);

   * @param {string} method Http method to use.

   * @param {string} endpoint API endpoint to use.

   * @param {Object} [data] Data to send with the request.

    return new Promise((resolve, reject) => {

        options.headers.authorization = this.token;

        console.warn('[dblapi.js] Warning: No DBL token has been provided.'); // eslint-disable-line no-console

      if (data && method === 'post') options.headers['content-type'] = 'application/json';

      if (data && method === 'get') options.path += `?${qs.encode(data)}`;

      const request = https.request(options, res => {

        response.status = res.statusCode;

        response.ok = res.statusCode >= 200 && res.statusCode < 300;

        response.statusText = res.statusMessage;

          response.body = res.headers['content-type'].includes('application/json') ? JSON.parse(response.raw) : response.raw;

            const err = new Error(`${res.statusCode} ${res.statusMessage}`);

            Object.assign(err, response);

      if (data && method === 'post') request.write(JSON.stringify(data));

   * @param {number|number[]} serverCount The server count of your bot.

   * @param {number} [shardId] The ID of this shard.

   * @param {number} [shardCount] The count of all shards of your bot.

  async postStats(serverCount, shardId, shardCount) {

    if (!serverCount && !this.client) throw new Error('postStats requires 1 argument');

      data.server_count = this.client.guilds.size;

      if (this.client.shard && this.client.shard.count) {

        data.shard_id = this.client.shard.id;

        data.shard_count = this.client.shard.count;

      } else if (this.client.shards && this.client.shards.size !== 1) {

        data.shard_count = this.client.shards.size;

    const response = await this._request('post', 'bots/stats', data, true);

   * @param {string} id The ID of the bot you want to get the stats from.

    if (!id && !this.client) throw new Error('getStats requires id as argument');

    const response = await this._request('get', `bots/${id}/stats`);

   * @param {string} id The ID of the bot you want to get the information from.

    if (!id && !this.client) throw new Error('getBot requires id as argument');

    const response = await this._request('get', `bots/${id}`);

   * @param {string} id The ID of the user you want to get the information from.

    if (!id) throw new Error('getUser requires id as argument');

    const response = await this._request('get', `users/${id}`);

		{
		"name": "dblapi.js",
		"version": "2.3.0",
		"description": "An official module for interacting with the discordbots.org API",
		"version": "2.3.1",
		"description": "An official module for interacting with the top.gg API",
		"main": "index.js",
		@@ -16,3 +16,3 @@ "scripts": {
		],
		"author": "Discord Bot List <support@discordbots.org> (https://discordbots.org)",
		"author": "Discord Bot List <support@top.gg> (https://top.gg)",
		"repository": "DiscordBotList/dblapi.js",
		@@ -19,0 +19,0 @@ "license": "Apache-2.0",

		@@ -19,3 +19,3 @@ const EventEmitter = require('events');
		* Creates a new DBLAPI Instance.
		* @param {string} token Your discordbots.org token for this bot.
		* @param {string} token Your top.gg token for this bot.
		* @param {Object} [options] Your DBLAPI options.
		@@ -92,3 +92,3 @@ * @param {number} [options.statsInterval=1800000] How often the autoposter should post stats in ms. May not be smaller than 900000 and defaults to 1800000.
		const options = {
		hostname: 'discordbots.org',
		hostname: 'top.gg',
		path: `/api/${endpoint}`,
		@@ -95,0 +95,0 @@ method,

		# dblapi.js
		An official module for interacting with the discordbots.org API
		An official module for interacting with the top.gg API

		@@ -8,3 +8,3 @@ ## Installation
		## Documentation
		Documentation can be found [here](https://discordbots.org/api/docs#jslib)
		Documentation can be found [here](https://top.gg/api/docs#jslib)

		@@ -18,3 +18,3 @@ ## Example
		const DBL = require("dblapi.js");
		const dbl = new DBL('Your discordbots.org token', client);
		const dbl = new DBL('Your top.gg token', client);

		@@ -21,0 +21,0 @@ // Optional events

Improved metrics