Class Api

Create Top.gg API instance

Get bot info

Example

await api.getBot("461521980492087297"); // returns bot info
Copy

Get a list of bots

Example

// Finding by properties
await api.getBots({
  search: {
    username: "shiro",
    certifiedBot: true,
  },
});
// =>
{
  results: [
    {
      id: '461521980492087297',
      username: 'Shiro',
      discriminator: '8764',
      lib: 'discord.js',
      ...rest of bot object
    }
    ...other shiro knockoffs B)
  ],
  limit: 10,
  offset: 0,
  count: 1,
  total: 1
}
// Restricting fields
await api.getBots({
  fields: ["id", "username"],
});
// =>
{
  results: [
    {
      id: '461521980492087297',
      username: 'Shiro'
    },
    {
      id: '493716749342998541',
      username: 'Mimu'
    },
    ...
  ],
  ...
}
Copy

Get a bots stats

Example

await api.getStats("461521980492087297");
// =>
{
  serverCount: 28199,
  shardCount 1,
  shards: []
}
Copy

Get user info

Example

await api.getUser("205680187394752512");
// =>
user.username; // Xignotic
Copy

Get users who've voted

Example

await api.getVotes();
// =>
[
  {
    username: 'Xignotic',
    id: '205680187394752512',
    avatar: '3b9335670c7213b3a2d4e990081900c7'
  },
  {
    username: 'iara',
    id: '395526710101278721',
    avatar: '3d1477390b8d7c3cec717ac5c778f5f4'
  }
  ...more
]
Copy

Get whether or not a user has voted in the last 12 hours

Example

await api.hasVoted("205680187394752512");
// => true/false
Copy

Whether or not the weekend multiplier is active

Example

await api.isWeekend();
// => true/false
Copy

Post bot stats to Top.gg

Example

await api.postStats({
  serverCount: 28199,
  shardCount: 1,
});
Copy