leaderboards

Get a leaderboard page

All-time top 100 for one stat on one server, highest first (ties by UUID). Players with a private profile are left out and the positions close up. Cached for 5 minutes.

get/v1/leaderboards/{server}/{stat}

Request

  • Base URL: https://api.fabriccraft.net
  • URL: https://api.fabriccraft.net/v1/leaderboards/{server}/{stat}
  • Auth: none declared

Path parameters

server'survival' | 'creative' required

Game server.

stat'playtime' | 'deaths' | 'playerKills' | 'mobKills' | 'blocksMined' | 'itemsCrafted' | 'itemsUsed' | 'walk' | 'sprint' | 'swim' | 'elytra' | 'boat' | 'horse' | 'minecart' | 'jumps' | 'damageDealt' | 'damageTaken' | 'villagerTrades' | 'fishCaught' | 'animalsBred' | 'advancements' required

Board id (camelCase).

Query parameters

pageinteger

Page number. 1-10 with pageSize=10, 1-4 with pageSize=25.

pageSize10 | 25

Rows per page.

Response

One page of the leaderboard.

server'survival' | 'creative' required

Game server.

stat'playtime' | 'deaths' | 'playerKills' | 'mobKills' | 'blocksMined' | 'itemsCrafted' | 'itemsUsed' | 'walk' | 'sprint' | 'swim' | 'elytra' | 'boat' | 'horse' | 'minecart' | 'jumps' | 'damageDealt' | 'damageTaken' | 'villagerTrades' | 'fishCaught' | 'animalsBred' | 'advancements' required

Board id (camelCase).

labelstring required
unit'seconds' | 'count' | 'cm' | 'hp_tenths' required

seconds = whole seconds; count = plain counter; cm = centimetres; hp_tenths = tenths of a health point (divide by 20 for hearts).

builtAtstring date-time nullable required

When the board was last rebuilt, or null before the first build.

pageinteger required
totalEntriesinteger required

Entries on the whole board (at most 100); pages = ceil(totalEntries / pageSize).

Example response

{
  "entries": [
    {
      "uuid": "0f8c2a51-7d3e-4b9a-a6c1-2e5f9d84b730",
      "username": "Example_Player",
      "rank": {
        "name": "VIP",
        "color": {
          "stops": [
            "#edb300"
          ]
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.