The Spicerack API is currently in beta. While we strive to maintain backwards compatibility, breaking changes may occur. We recommend subscribing to our changelog to stay updated on any API changes.

Welcome

The Spicerack API allows you to programmatically access information about your tournaments and organization. To use the API, you’ll need an API key for authentication.

Getting an API Key

  1. Navigate to the API Keys section in your organization’s admin panel
  2. Click “Create API Key”
  3. Provide a name for your key and select the appropriate access level
  4. Optionally set an expiration date
  5. Store your API key securely - you won’t be able to see it again after creation

Authentication

All API endpoints require authentication using an API key. Include your API key in the request headers:

X-API-Key: sk_*****

If an invalid or expired API key is provided, the API will return a 401 Unauthorized response. If the API key doesn’t have sufficient permissions for the requested operation, a 403 Forbidden response will be returned.

API Access Levels

API keys are tied to specific organization roles, which determine what operations they can perform. When creating an API key, you’ll need to select a member access level that defines its permissions.

Making Requests

All API requests should be made to the base URL with your API key included in the headers. Here’s an example:

curl https://api.spicerack.gg/api/v1/<endpoint> \
  -H "X-API-Key: sk_*****"

Response Format

All responses are returned in JSON format. Successful responses will have a 2xx status code, while errors will return an appropriate error code along with an error message in the response body.