Skip to content

Getting Started

Use the production API at:

https://slowstack.tv/api/v1

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.

Use the key with the Authorization header.

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

Most endpoints return:

{
"data": [],
"meta": {
"hasMore": false
}
}
  • GET /servers
  • GET /servers/{ip}/{port}
  • GET /servers/{ip}/{port}/players
  • GET /players
  • GET /players/{uuid}
  • GET /players/{uuid}/sessions

No other routes are allowed with developer API keys.

Developer API keys are read-only.

  • Only GET requests are permitted.
  • POST, PUT, PATCH, and DELETE requests are rejected.
  • Developer API keys are limited to 60 requests per 60 seconds per key.
  • On 429, respect Retry-After and retry with exponential backoff + jitter.

These endpoints are intentionally blocked for developer keys:

  • /servers/locations
  • /servers/heatmap
  • /streams
  • tag endpoints
  • account export endpoints
  • all other /api/v1/* routes not listed above