TopARKServers API

An easy to use API for displaying ARK: Survival Evolved server data and voting information.

We provide several API endpoints to access server, player and voting information.
For more information on a specific API, please select the API from the side menu.

If you're a developer and would like to use our system in a mod or plugin, contact us and we can build an API specifically for your mod / plugin.

Server Details API Authentication

To access the Server Details API, you will need to authenticate your request using a Server Key. The Server Key can be obtained on the manage server page for claimed server owners. The request should look like the example below.

Server Details Recommended Use

The server details endpoint will output server related information that was gathered during the last tracking phase. Developers typically use this endpoint to display their server information on websites, banners or status pages.

Server Details API Ratelimit

You are allowed to make 3600 request an hour which is 60 request a minute. Exceeding this limit will result in a 1 hour cooldown. The cooldown will scale based on the amount of times the Server Key has exceeded the limit.

Server Details API Response

A successful Server Details API will output the following information for the server.

ServerDetails Type Description
ServerID String The id of the server
Title String The server title
IpAddress String The server's ip address
QueryPort Number The server's query port
GamePort Number The server's game port
Status String The server's online / offline status
Votes Number The server's total vote count
Players Number Player count from recent tracking results
MaxPlayers Number The total amount of players the server can hold
ClusterPlayers Number The total amount of players for the combined cluster
ClusterMaxPlayers Number The total amount of players the cluster can hold

ServerPlayers Array of Strings Description
Id Number This value is always 0
Name String The name of the player
Frags Number The amount of kills(Not all games support this)
Time Number The time spent on the server
TimeF Time The time spent on the server (Formatted)
"ServerDetails":{
  "ServerID": "00000",
  "Title": "ServerName",
  "IpAddress": "192.0.0.0",
  "QueryPort": "27015",
  "GamePort": "7777",
  "Map": "map",
  "Status":"online",
	"Votes": "10",
	"Rank": "10",
  "Players": "7",
  "MaxPlayers": "100",
  "ClusterPlayers": "78",
  "ClusterMaxPlayers": "450",
},
"Serverplayers": [
        {
            "Id": 0,
            "Name": "admin",
            "Frags": 0,
            "Time": 1610,
            "TimeF": "26:50"
        },
        {
            "Id": 0,
            "Name": "test",
            "Frags": 0,
            "Time": 1393,
            "TimeF": "23:13"
        },
				{
            "Id": 0,
            "Name": "test3",
            "Frags": 0,
            "Time": 1393,
            "TimeF": "23:13"
        },
				{
            "Id": 0,
            "Name": "test2",
            "Frags": 0,
            "Time": 1393,
            "TimeF": "23:13"
        }
    ]
  

Voting Details API Authentication

To access the Voting Details API, you will need to authenticate your request using a Server Key. The Server Key can be obtained on the manage server page for claimed server owners. The request should look like the example below.

Voting Details Recommended Use

The voting details endpoint will output the username, vote count, claim count, last vote time and the Steam ID for every user who has voted for the server. The output is automatically sorted by their total votes. Developers typically use this endpoint to reward the top voters for each month or display the current vote stats on a website.

Voting Details API Ratelimit

You are allowed to make 3600 request an hour which is 60 request a minute. Exceeding this limit will result in a 1 hour cooldown. The cooldown will scale based on the amount of times the Server Key has exceeded the limit.

Voting Details API Response

A successful request to the voting details API will output the following information for the server.

Field Type Description
serverid String The id of the server
servername String The server title
ip String The server's ip address
queryport Number The server's query port
gameport Number The server's game port
votes Number The monthly total count
voters Array of Strings The voter details
{
    "serverid": "00000",
    "servername": "ServerName",
    "ip": "192.0.0.0",
    "queryport": "27015",
    "gameport": "7777",
    "votes": "10",
    "voters": [
    	{
      	"username": "Support",
      	"votecount": "1",
      	"votesclaimed": "1",
      	"lastvotetime": "2020-08-18 18:47:34",
      	"steamid": "777777777"
    	}
    ]
  }
    

Voting Rewards API Request

Our Voting Rewards API is a HTTP/REST for general operations such as sending POST requests and receiving GET requests.

Voting Rewards API

If you are a developer or plugin manager and you would like to create a mod or plugin that rewards players who vote, you can use our Voting Rewards API you will need to authenticate your request, this is done by using a Server Key and the SteamID of a user who has cast a vote. The Server Key can be obtained on the manage server page for claimed server owners, the SteamID can be obtained from your servers player log.

There are 2 options for the Voting Rewards API Endpoint. /status & /claim, status is used to check the status of a vote cast on a server by a user based on their SteamID. The claim option is used to reward players who vote for the server. This can be done using the ARK API or creating a custom server mod.

Voting Rewards API Response

A successful Voting Rewards API request will output the following information for the server.

Field Type Description
username String The username of the voter.
votetype String The type of vote the user cast.
lastvotetime Date / Time The date and time of the last vote cast.
claimstatus String Claimed or unclaimed status.
rewardvalue Number Number value for the old API.
totalunclaimedvotes Number The total unclaimed votes for the voter.
reason String The rewardvalue reason.
0 - Invalid Server Key, Steam ID or no vote.
1 - Reward the player.
2 - Do not reward the player.

{
	"username": "Support",
	"votetype": "like",
	"lastvotetime": "2099-01-12 13:05:26",
	"rewardvalue": "1",
	"totalunclaimedvotes": 5,
	"reason": "You can reward the player."
	}
Add your server today and view real-time server information, it's FREE!