API Reference
API Overview
Integrate with Rankly.gg programmatically. Access leaderboards, kill feeds, player stats, and more through our RESTful JSON API.
Base URL
https://rankly.gg/apiAll endpoints are served over HTTPS. Plain HTTP requests will be redirected.
Authentication
All API requests require an API key passed in the X-API-Key header. See the Authentication docs for details on key generation and usage.
curl -H "X-API-Key: RNKLY-XXXX-XXXX-XXXX-XXXX" \ https://rankly.gg/api/ingest
Rate Limits
API requests are limited to 60 requests per minute per API key. Rate limit information is included in response headers.
X-RateLimit-LimitMaximum requests per minute (60)X-RateLimit-RemainingRequests remaining in the current windowExceeding the limit returns a 429 response with a retry_after_ms field.
Response Format
All responses are JSON. Successful responses include a top-level structure with the relevant data. Error responses include an error field with a human-readable message.
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Invalid API key"
}