Docs Menu

Getting Started

Base URL

Use the production API at:

https://slowstack.tv/api/v1

Step 1: Create your API key

Create your key in your Slowstack profile settings.

  • You can only have one key at a time.
  • The full key is shown once when created or rotated.
  • Store the key in your backend secret manager.

Step 2: Send your first request

Use the key with the Authorization header.

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

Step 3: Parse response payloads

Most endpoints return:

{
  "data": [],
  "meta": {
    "hasMore": false
  }
}

Available endpoints for API keys

  • GET /servers
  • GET /servers/{ip}/{port}
  • GET /servers/{ip}/{port}/players
  • GET /players
  • GET /players/{uuid}
  • GET /players/{uuid}/sessions

Read-only behavior

Developer API keys are read-only. Only GET is supported; any other method returns 405.

Rate limit

  • 20 requests per 60 seconds and 1,000 requests per 24 hours.
  • Deep pagination costs more: requests with offset >= 500 count as 2 requests, offset >= 2000 as 4.
  • On 429, respect Retry-After and back off with jitter.