API
We offer a publicly usable API for our servers added to the server list. Through the API, we publicly provide most of the information that is displayed about TeamSpeak 3 servers here on our server list.
You can use this API, for example, to display server information on your website, etc.
A maximum of 500 requests per 15 minutes is allowed, after which the IP address will be blocked! Request an increase in the request limit
429 Too Many Requests until the window resets.Available endpoints
Server info
Returns the current status and basic information about the server.
The endpoint for each server is located at:
| Field | Type | Description |
|---|---|---|
success | boolean | Always true when the server was found. |
timestamp | number | Unix timestamp (ms) of when this response was generated. |
ip_address | string | Public IP address / hostname of the server. |
port | number | Server port. |
online | boolean | Whether the server was reachable during the last check. |
clients | number | Number of clients currently connected. |
clients_max | number | Maximum number of client slots. |
name | string | null | Server name, or null when offline. |
uptime | number | Server uptime in seconds. |
version | string | null | TeamSpeak 3 server software version. |
reserved_slots | number | Number of reserved slots. |
channels | number | Number of channels on the server. |
ping | number | null | Server ping in milliseconds, or null when offline. |
Statistics
Returns a time series usable for graphs, as an array of { "x": timestamp_ms, "y": value } objects. Add the query parameter ?days=1 (default - last 24 hours, hourly buckets), ?days=7 or ?days=30 (last 7/30 days, daily buckets).
| Endpoint | What y represents |
|---|---|
stats-votes.json | Number of votes received in that time bucket. |
stats-views.json | Number of server page views in that time bucket. |
stats-clients.json | Peak number of connected clients in that time bucket. |
stats-ping.json | Peak ping (ms) in that time bucket. |
stats-packet-loss.json | Peak packet loss (%) in that time bucket. |
404 Not Found is returned if the server does not exist on our server list. 429 Too Many Requests is returned if you exceed the rate limit above.Usage examples:
<?php
try {
$server = json_decode(file_get_contents("https://teamspeak3-servers.eu/server/teamspeak-server.eu:9987/api.json"), false);
echo "Clients on-line: ".$server->clients; //on-line clients count
echo "Maximum clients: ".$server->clients_max; //maximum clients
echo "Current server ping: ".$server->ping; //current ping
} catch (Exception $e) {
echo "There is a error: ".$e->getMessage();
}
?>
<script>
fetch("https://teamspeak3-servers.eu/server/teamspeak-server.eu:9987/api.json").then(async (result) => {
if (result.ok) {
let server = await result.json();
console.log("Clients on-line: "+server.clients);
console.log("Maximum clients: "+server.clients_max);
console.log("Current server ping: "+server.ping);
}
}).catch((err) => {
console.error("There is a error: ", err);
});
</script>