Skip to content

introduction.mdx

Latest commit

 

History

History
41 lines (29 loc) · 1.75 KB

introduction.mdx

File metadata and controls

41 lines (29 loc) · 1.75 KB
Raw
title Top.gg Developer Documentation
description Top.gg is a discovery platform for Discovery on the web. Use the REST API to post statistics, read votes, configure webhooks, and build integrations.

Top.gg is a discovery platform where developers list, promote, and grow Discord bots and servers. The public REST API lets you integrate your bot directly with Top.gg - posting server stats, reading voter data, and reacting to vote events in real time.

The API offers two versions: v1 is the current RESTful API, and v0 is the legacy API still supported for existing integrations. New projects should use v1.

What you can do

  • Post your bot's server and shard count to keep your listing up to date
  • Check whether a specific user has voted for your bot
  • Retrieve vote and listing data for your bot or other bots
  • Listen for vote events via webhooks to reward voters automatically
  • Search and browse bots and servers listed on the platform

Get started

Learn how to get your API token and authenticate requests to both v0 and v1 endpoints. Receive real-time vote events and react to them inside your bot.

API versions

Version Base URL Status
v1 https://top.gg/api/v1 Current
v0 https://top.gg/api Legacy

Use v1 for all new integrations. The v0 API remains functional for existing projects but does not receive new features.

Get help

Join the Top.gg Discord server and visit the #topgg-api channel for community support and questions: discord.gg/EYHTgJX