Leaderboards
Create Leaderboard
Define a new leaderboard for your app. The slug must be unique within the app.
POST
/api/leaderboards/create.php
Requires
Authorization: AppID:AppKey headerRequest body
| Field | Type | Required | Description |
|---|---|---|---|
| slug | string | required | Unique identifier [a-z0-9_-]. E.g. goals |
| name | string | required | Display name. E.g. "Top Scorers" |
| points_name | string | optional | Score unit label. E.g. "Goals", "ms". Default: "Points" |
| sort_order | string | optional | desc — higher is better (default). asc — lower is better (e.g. lap times). |
Test this endpoint
Headers
Body
Success response 200
{
"success": true,
"leaderboard": {
"id": 1,
"app_id": "com.myapp.game",
"slug": "goals",
"name": "Top Scorers",
"points_name": "Goals",
"sort_order": "desc",
"created_at": "2026-05-29 14:00:00"
}
}
Errors
| Code | Message | Cause |
|---|---|---|
| 401 | Invalid app credentials. | Bad AppID or AppKey |
| 400 | slug and name are required. | Missing fields |
| 400 | Invalid slug format. | Characters outside [a-z0-9_-] |
| 409 | A leaderboard with this slug already exists for this app. | Duplicate slug |