Docs Menu

List Players

Endpoint

GET /api/v1/players

Query parameters

  • limit number of records to return
  • search optional player name search
  • sort one of recent or name
  • cracked filter by cracked status (true or false; omit for both)
  • geyser filter by Geyser/bedrock players (true or false; 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/players?limit=20&sort=recent&offset=0" 
  -H "Authorization: Bearer YOUR_API_KEY"

Code examples

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

const response = await fetch(`https://slowstack.tv/api/v1/players?${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]?.uuid, result.data[0]?.currentServerIp);

Response

{
  "data": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "name": "ExamplePlayer",
      "isCracked": false,
      "isGeyser": false,
      "updatedAt": "2026-02-21T09:31:15.000Z",
      "currentServerIp": 16909060,
      "currentServerPort": 25565,
      "currentServerJoinedAt": "2026-02-21T08:44:00.000Z"
    }
  ],
  "meta": {
    "hasMore": true
  }
}

currentServerIp is a signed 32-bit integer when present. See IP Address Integer Format for conversion examples in JavaScript, Python, and Java.