AtlasServerlist Voting API

With our voting API you can build mods or use plugins to reward players who vote for your server

What's Needed

Creating a plugin or mod that uses our API should have the following functions:

  • A plugin or mod that is compatible
  • A /vote command
  • A /status command
  • A /claim command
  • An API ServerKey
Although it's not required you have these 3 commands, we recommend them.
Voting API

How It Works

Please remember that votes are tracked and if we find you're trying to abuse the system you will be banned along with your server. You will need the two following items.

[ServerKey]: A server key is a unique key that is assigned to each server. You can find this key on the manage server page located under the claimed servers tab on the account page.

[ServerID]: This is the ID on your server in our system. You can find it under the claimed servers tab on the account page or on your servers page in the URL trailing /server/xxxxxxx.

[STEP-1]: The player sends a command on your server using /vote. This will display a link to your server's voting page.


User Input: /vote
Server Response: https://atlasserverlist.com/vote/{ServerID}
Example: https://atlasserverlist.com/vote/177777777

[STEP-2]: The player is prompted to verify if they're Steam verified. Steam Verified is required as their SteamID will be used to verify they have voted on your server.


User Input: The user selects a voting status from the link that was provided in [STEP-1]
Server Response: Our system accepted their vote and is ready for [STEP-3]

[STEP-3]: The player sends a command on your server using /claim. This will check if they have voted in the past 12 hours and if they have reward them.


User Input: /claim
Server Response: The player is rewarded if they voted in the past 12 hours.

Developers - Vote Status

Checking the vote status of a player does not reward them, it's simply used to check if they've voted / claimed their reward in the last 12 hours.
Typical usage of this would be to query our API system when a user joins your server to check if they have voted, if not, remind them they can /vote


HTTP GET request
https://atlasserverlist.com/rewards?status&serverkey={ServerKey}&steamid={SteamID}

HTTP GET request example
https://atlasserverlist.com/rewards?status&serverkey=xxxxxxxxxxxxxxxxx&steamid=xxxxxxxxxxxxxxxxx
API Response Action
0 The API ServerKey is incorrect or the SteamID was not found
1 The player's SteamID was located in our database and they have voted in the last 12 hours. You can reward the player using /claim
2 The player has already voted and claimed their reward.
We do not alter or modify our API response. Please do not request any modifications as they will be denied.

Developers - Claim Reward

Rewards the player for voting in the last 12 hours.
Typical usage of this would be query our API system when a user uses the /claim command to check the response and reward the player if needed


HTTP GET request
https://atlasserverlist.com/rewards?claim&serverkey={ServerKey}&steamid={SteamID}

HTTP GET request example
https://atlasserverlist.com/rewards?claim&serverkey=xxxxxxxxxxxxxxxxx&steamid=xxxxxxxxxxxxxxxxx
API Response Action
0 The API ServerKey is incorrect or the SteamID was not found
1 The player's SteamID was located in our database and they have voted in the last 12 hours. Reward the player
2 The player has already claimed their reward or they have not voted in the last 12 hours. DO NOT REWARD THEM.
We do not alter or modify our API response. Please do not request any modifications as they will be denied.