Base Configuration
Authentication
All API requests require authentication using an API Key. Generate your API Key in your server dashboard: Dashboard Path: Edit Server → Advanced Setup → API Key- Header
- Query Parameter
Keep your API Key secure and never share it publicly. Treat it like a password to your server data.
Rate Limiting
The Public API enforces rate limits to ensure fair usage:| Limit | Value |
|---|---|
| Requests per minute | 120 |
| Per | API Key |
| Exceeded response | 429 Too Many Requests |
Rate limit headers are planned for a future update. Currently, responses don’t include rate limit information.
Endpoints
Get Server Details
Retrieve public information about your server.Fetch server details
Get Bot Details
Retrieve public information about your bot.Fetch bot details
Check User Vote Status
Verify if a user can vote or is on cooldown.Check vote eligibility
| Parameter | Type | Description |
|---|---|---|
userId | string | Discord User ID to check |
Get Server Reviews
Retrieve the latest reviews for your server with flexible filtering.Fetch server reviews
| Parameter | Type | Default | Max | Description |
|---|---|---|---|---|
limit | integer | 10 | 50 | Number of reviews to return |
sort | string | newest | - | Sort order: newest, highest, lowest |
Error Handling
All API errors follow a consistent JSON structure:| Status | Error | Description |
|---|---|---|
| 401 | Unauthorized | Invalid or missing API Key |
| 404 | Not Found | Server or resource not found |
| 429 | Too Many Requests | Rate limit exceeded |
Code Examples
- cURL
- JavaScript
- Python
- Go
Best Practices
Security
Security
- Store API keys in environment variables, never hardcode them
- Use HTTPS for all requests (never HTTP)
- Rotate keys regularly if they may be compromised
- Use different keys for different applications
Performance
Performance
- Cache responses when appropriate to avoid unnecessary requests
- Implement exponential backoff for rate limit handling
- Batch requests when possible
- Monitor your API usage to stay within rate limits
Error Handling
Error Handling
- Implement retry logic with exponential backoff for failed requests
- Handle rate limit responses (429) gracefully
- Log API errors for debugging purposes
- Provide meaningful error messages to users
What’s Next
Webhooks
Receive real-time events when users vote or purchase premium
Earning Credits
Learn how to maximize credits from your server