Docs Menu

List Servers

Endpoint

GET /api/v1/servers

Query parameters

  • limit number of records to return
  • search free text filter (IP, IP:PORT, reverse-DNS hostname, or description text)
  • description description-only text filter
  • version protocol version filter
  • onlineOnly set to true for recently seen online servers
  • minPlayers minimum online player count
  • maxPlayers maximum online player count
  • countryCodes comma-separated ISO country codes (for example US,DE,BR)
  • forgeMods comma-separated Forge mod IDs; matching is exact and case-insensitive, and servers must contain every supplied mod (maximum 10)
  • onlineMode true or false to filter by online mode (cracked servers have online mode false; omit for both)
  • whitelisted true or false to filter by whitelist status (omit for both)
  • offset pagination offset

Pagination behavior

  • Use limit + offset for pagination.
  • Response metadata includes meta.hasMore.

Example

curl -X GET "https://slowstack.tv/api/v1/servers?limit=20&offset=0" 
  -H "Authorization: Bearer YOUR_API_KEY"

Code examples

const params = new URLSearchParams({
  limit: '20',
  offset: '0'
});

const response = await fetch(`https://slowstack.tv/api/v1/servers?${params.toString()}`, {
  headers: { Authorization: 'Bearer YOUR_API_KEY' }
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);

const result = await response.json();
console.log(result.data[0]?.ipAddress, result.meta?.hasMore);

Response

{
  "data": [
    {
      "ipAddress": 1981539350,
      "port": 25565,
      "version": "1.21.5",
      "maxPlayers": 20,
      "players": 0,
      "description": "A Minecraft Server",
      "descriptionExtra": "",
      "updatedAt": "2026-02-21T10:03:52.647Z",
      "favicon": "https://.../6545018510055934522.png"
    }
  ],
  "meta": {
    "hasMore": true
  }
}

ipAddress values are signed 32-bit integers. See IP Address Integer Format for conversion examples in JavaScript, Python, and Java.