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 top.gg API",

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

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

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

    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 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

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

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

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

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

        if (this.client.shard.ids && this.client.shard.ids.length === 1 && this.client.shard.count > 1) {

          data.shard_id = this.client.shard.ids[0];

          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}`);

   * Gets a list of bots matching your query.

   * @param {Object} query The query for the search.

    const response = await this._request('get', 'bots', query);

    const response = await this._request('get', 'bots/votes', undefined, true);

   * Returns true if a user has voted for your bot in the last 24h.

   * @param {string} id The ID of the user to check for.

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

    const response = await this._request('get', 'bots/check', { userId: id }, true);

   * Returns true if the weekend multiplier is currently active.

    const response = await this._request('get', 'weekend');

declare class DBLAPI extends EventEmitter {

  constructor(token: string, options: DBLAPI.DBLOptions, client?: object);

  constructor(token: string, client?: object);

  public postStats(serverCount: number, shardId?: number, shardCount?: number): Promise<object>

  public getStats(id: string): Promise<DBLAPI.BotStats>

  public getBot(id: string): Promise<DBLAPI.Bot>

  public getUser(id: string): Promise<DBLAPI.User>

  public getBots(query: DBLAPI.BotsQuery): Promise<DBLAPI.BotSearchResult>

  public getVotes(): Promise<DBLAPI.Vote[]>

  public hasVoted(id: string): Promise<boolean>

  private _request(method: string, endpoint: string, data?: object): Promise<object>

  public on(event: 'posted', listener: () => void): this;

  public on(event: 'error', listener: (error: Error) => void): this;

import { Server, ServerResponse, IncomingMessage } from 'http';

declare class DBLWebhook extends EventEmitter {

  constructor(port?: number, path?: string, auth?: string, server?: Server)

  private _attachWebhook(server: Server): void;

  private _handleRequest(req: IncomingMessage, res: ServerResponse): void;

  private _returnResponse(res: ServerResponse, statusCode: number, data?: string): void;

  public on(event: 'ready', listener: (hostname: string, port: number, path: string) => void): this;

  public on(event: 'vote', listener: (bot: string, user: string, type: string, isWeekend: boolean, query?: object) => void): this;

		{
		"name": "dblapi.js",
		"version": "2.3.1",
		"version": "2.4.0",
		"description": "An official module for interacting with the top.gg API",
		@@ -5,0 +5,0 @@ "main": "index.js",

		@@ -8,2 +8,3 @@ export = DBLAPI;

		public webhook?: DBLWebhook;
		public postStats(serverCount: number, shardId?: number, shardCount?: number): Promise<object>
		@@ -10,0 +11,0 @@ public getStats(id: string): Promise<DBLAPI.BotStats>

Improved metrics

Worsened metrics

		@@ -149,5 +149,9 @@ const EventEmitter = require('events');
		} else {
		data.server_count = this.client.guilds.size;
		data.server_count = this.client.guilds.size \|\| this.client.guilds.cache.size;
		if (this.client.shard && this.client.shard.count) {
		data.shard_id = this.client.shard.id;
		if (this.client.shard.ids && this.client.shard.ids.length === 1 && this.client.shard.count > 1) {
		data.shard_id = this.client.shard.ids[0];
		} else {
		data.shard_id = this.client.shard.id;
		}
		data.shard_count = this.client.shard.count;
		@@ -154,0 +158,0 @@ } else if (this.client.shards && this.client.shards.size !== 1) {