Skip to main content

Get bundle

GET 
/leaderboards/:leaderboard_slug/bundle

Request any combination of sections in one response. Requires x-client-id, x-client-secret, and Authorization bearer token. Caller must have client.leaderboard permission.

Request​

Responses​

Successful Response

Query parameters​

  • include (required): comma-separated sections — meta, leagues, rewards, entries, users, me
  • league, limit, offset, source, expand: passed through to applicable sections

Unknown include values or an empty include return 400. Omitted sections are returned as null.

Response example (200 OK)​

{
  "meta": null,
  "leagues": null,
  "rewards": null,
  "entries": {
    "pagination": { "limit": 50, "offset": 0, "total": 120, "has_more": true },
    "league": "gold",
    "entries": []
  },
  "users": null,
  "me": {
    "leaderboard_id": 12,
    "leaderboard_slug": "daily-elo",
    "leaderboard_name": "Daily ELO",
    "user_id": 101,
    "rank": 7,
    "stat_value": 2150.0,
    "league": "gold",
    "expired": false
  }
}

cURL example​

curl -X GET "http://localhost:8000/client/leaderboards/daily-elo/bundle?include=entries,me&league=gold&limit=50" \
  -H "x-client-id: <your-client-id>" \
  -H "x-client-secret: <your-client-secret>" \
  -H "Authorization: Bearer <access-token>"