API Documentation

Integrate RustServerList.com with your server plugins and tools.
All endpoints below use your server API key for authentication.

Authentication

Every request requires your server API key as the key query parameter. Claim your server, open Edit Server, and generate an API key there. Keep the key private — anyone with it can query your server data and mark vote rewards as claimed. API access only works while your server is actively listed.

In plugin configs, placeholders like {0} and {1} usually map to your server key and the player's Steam ID.

GET

Vote Status

Check whether a player voted on your server in the last 24 hours and whether their reward has already been claimed.

https://rustserverlist.com/api/vote?action=status&key=YOUR_API_KEY&steamid=00000000000000000

Parameter	Description	Required
`action`	Must be `status`	Yes
`key`	Your server API key	Yes
`steamid`	Player's 64-bit Steam ID	Yes

Example response	Meaning
`0`	No matching vote found
`1`	Voted, reward not yet claimed
`2`	Voted, reward already claimed

GET

Claim Reward

Mark a player's vote as claimed after delivering their reward. Only affects votes from the last 24 hours.

https://rustserverlist.com/api/vote?action=claim&key=YOUR_API_KEY&steamid=00000000000000000

Parameter	Description	Required
`action`	Must be `claim`	Yes
`key`	Your server API key	Yes
`steamid`	Player's 64-bit Steam ID	Yes

Example response	Meaning
`0`	Vote was not claimed (no eligible vote found)
`1`	Vote successfully marked as claimed

GET JSON

Vote History

Returns up to the latest 1000 votes for your server. Test votes are excluded by default. Add include_test=1 to include them — each vote then includes a test field.

https://rustserverlist.com/api/votes?key=YOUR_API_KEY

Parameter	Description	Required
`key`	Your server API key	Yes
`include_test`	`1` or `true` to include test votes; `0` or `false` to exclude. Defaults to `false` if omitted	No

{
  "success": true,
  "server_id": 0,
  "count": 0,
  "limit": 1000,
  "include_test": false,
  "steamid": null,
  "votes": [
    {
      "id": 0,
      "personaname": "0",
      "steamid": "00000000000000000",
      "voted_at": 0,
      "claimed": false,
      "claimed_at": null
    },
    {
      "id": 0,
      "personaname": "0",
      "steamid": "00000000000000000",
      "voted_at": 0,
      "claimed": false,
      "claimed_at": null
    }
  ]
}

GET JSON

Vote History (Single Player)

Same JSON format as Vote History, filtered to one Steam ID (latest 1000 matching votes).

https://rustserverlist.com/api/votes?key=YOUR_API_KEY&steamid=00000000000000000

Parameter	Description	Required
`key`	Your server API key	Yes
`steamid`	Player's 64-bit Steam ID	Yes
`include_test`	`1` or `true` to include test votes; `0` or `false` to exclude. Defaults to `false` if omitted	No

{
  "success": true,
  "server_id": 0,
  "count": 0,
  "limit": 1000,
  "include_test": false,
  "steamid": "00000000000000000",
  "votes": [
    {
      "id": 0,
      "personaname": "0",
      "steamid": "00000000000000000",
      "voted_at": 0,
      "claimed": false,
      "claimed_at": null
    }
  ]
}

GET JSON

Server Stats

Returns detailed live and listing stats: hostname, rank, points, online players, map, vote totals, and performance metrics.

https://rustserverlist.com/api/server_stats?key=YOUR_API_KEY

Parameter	Description	Required
`key`	Your server API key	Yes

{
  "success": true,
  "server": {
    "id": 0,
    "hostname": "0",
    "online": false,
    "rank": 0,
    "points": 0
  },
  "connection": {
    "ip": "0.0.0.0",
    "port": 0,
    "query_port": 0,
    "favendpoint": "0.0.0.0",
    "connect": "0.0.0.0:0",
    "url": "0"
  },
  "players": {
    "online": 0,
    "max": 0,
    "percentage": 0.0
  },
  "world": {
    "map": "0",
    "world_size": "0",
    "world_seed": "0",
    "gather_rate": 0,
    "team_size": 0,
    "pve": "0",
    "server_born": 0,
    "types": []
  },
  "performance": {
    "fps": 0.0,
    "fps_avg": 0.0,
    "uptime": 0.0,
    "ram_sys": 0,
    "gc_cl": 0,
    "gc_mb": 0
  },
  "timestamps": {
    "last_seen": 0,
    "last_checked_at": 0,
    "offline_since": null,
    "days_offline": 0,
    "created_at": 0
  },
  "votes": {
    "total": 0,
    "this_month": 0,
    "unclaimed_last_24h": 0
  }
}

EasyVoteExtended Example

Add this provider block to your EasyVoteExtended config.

{
  "RustServerList.com": {
    "API Claim Reward (GET URL)": "https://rustserverlist.com/api/vote?action=claim&key={0}&steamid={1}",
    "API Vote status (GET URL)": "https://rustserverlist.com/api/vote?action=status&key={0}&steamid={1}",
    "Vote link (URL)": "https://rustserverlist.com/server/0",
    "Site Uses Username Instead of Player Steam ID?": "false"
  }
}

Map your server credentials in the Server Voting IDs and Keys section as ID:YOUR_API_KEY (your RustServerList server ID, then your API key).