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.
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.
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.
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.
A successful Server 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 |
| map | String | The server's map |
| status | String | The server's online / offline status |
| gameport | Number | The server's game port |
| players | Number | Player count from recent tracking results |
| maxplayers | Number | The total amount of players the server can hold |
| votes | Number | The total amount of votes for the server |
| voters | Array of Strings | The username and their total vote count |
Top{
"serverid": "00000",
"servername": "Topconanservers - Conan",
"ip": "192.0.0.0",
"queryport": "27015",
"gameport": "7777",
"map": "The Exiled Lands",
"status":"online",
"players": "7",
"maxplayers": "100",
"votes": "10",
"voters": [
{
"username": "Support",
"totalvotes": "10"
}
]
}
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.
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.
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.
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": "TopConanServers - Conan",
"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"
}
]
}
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 by created a custom script a custom server mod.
A successful Voting Rewards API request will output the following information for the server.
| Field | Type | Description |
|---|---|---|
| username | String | The topconanservers 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": "2020-01-12 13:05:26",
"rewardvalue": "1",
"totalunclaimedvotes": 5,
"reason": "You can reward the player."
}