Top
Our API is a HTTP/REST for general operations such as sending POST requests and receiving GET requests.
To access our API you will need to authenticate your request, this is done by 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.
A successful Server API request will output the following information for the server.
| Field | Type | Description |
|---|---|---|
| serverid | String | The id of the server |
| servername | String | The server title |
| display | Boolean | The server is visible to the world or is currently a display server for a cluster |
| ip | String | The server's ip address |
| queryport | Number | The server's query port |
| gameport | Number | The server's game port |
| players | Number | The total amount of players detected on the last tracking phase |
| 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 |
| votes | Number | The total amount of votes for the server |
| voters | Array of Strings | The username and their total vote count |
{
"serverid": "00000",
"servername": "Toparkservers - ARK",
"display": "true",
"ip": "192.0.0.0",
"queryport": "27015",
"gameport": "7777",
"map": "Ragnarok",
"players": "7",
"maxplayers": "100",
"clusterplayers": "78",
"clustermaxplayers": "450",
"votes": "10",
"voters": [
{
"username": "Support",
"totalvotes": "10"
}
]
}
Our Voting Rewards API is a HTTP/REST for general operations such as sending POST requests and receiving GET requests.
To access our Voting Rewards API you will need to authenticate your request, this is done by using a Server Key, SteamID. 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.
A successful Voting Rewards API request will output the following information for the server.
| Field | Type | Description |
|---|---|---|
| username | String | The TopArkServers username of the player who voted. (This is not their Steam name) |
| votetype | String | The type of vote the user cast. This can be used to only reward players who cast a like vote |
| rewardvalue | Number | The value to be used with Steam mods or other APIs |
| reason | Number | The rewardvalue reason. 0 - No voting record was found or the SteamID - ServerKey is invalid. 1 - The player's SteamID was located in our database and they have voted in the last 12 hours. You can reward the player. 2 - The player has already claimed their reward or they have not voted in the last 12 hours. |
{
"username": "Support",
"votetype": "like",
"rewardvalue": "1",
"reason": "You can reward the player."
}