TopARKServers API

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.

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

{
    "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.

{
	"username": "Support",
	"votetype": "like",
	"lastvotetime": "2099-01-12 13:05:26",
	"rewardvalue": "1",
	"totalunclaimedvotes": 5,
	"reason": "You can reward the player."
	}