Leaderboards

Fetch the top players for a Zeqa stat or ranked ELO key.

GET /leaderboard/{key}

Example:

curl "https://app.zeqa.net/api/leaderboard/sumo"

Path Parameters

Parameter	Type	Description
key	string	Leaderboard key, such as sumo, bridge, or kills.

Response Shape

The result field is an array ordered by leaderboard position. Each row contains username and one numeric field matching the requested key.

{
  "err": null,
  "result": [
    {
      "username": "Silvreste",
      "sumo": 3006
    },
    {
      "username": "LazyColt1537648",
      "sumo": 2709
    }
  ]
}

Result Item Fields

Field	Type	Description
username	string	Player username.
{key}	number	Score, ELO, or counter value for the requested leaderboard key.

For /leaderboard/sumo, each item has a sumo field. For /leaderboard/kills, each item has a kills field.

Observed Leaderboard Keys

These keys were observed in the player stats response and can be used as leaderboard or ranking keys where supported by the API.

Ranked ELO Keys

Key	Meaning
boxing	Boxing ELO.
fireballfight	FireballFight ELO.
bedfight	BedFight ELO.
nodebuff	Nodebuff ELO.
bridge	Bridge ELO.
battlerush	BattleRush ELO.
sumo	Sumo ELO.
builduhc	BuildUHC ELO.
finaluhc	FinalUHC ELO.
fireballmace	FireballMace ELO.
parkour	Parkour ELO.
crystalpvp	CrystalPvP ELO.

Lifetime Stat Keys

Key	Meaning
kills	Lifetime kills.
deaths	Lifetime deaths.
coins	Coins value.
shards	Shards value.
bp	Battle-pass or progression points value.

JavaScript Example

async function getLeaderboard(key) {
  const response = await fetch(
    `https://app.zeqa.net/api/leaderboard/${encodeURIComponent(key)}`,
  );
  const data = await response.json();

  if (data.err) {
    throw new Error(data.err);
  }

  return data.result;
}

Error Response

{
  "err": "Unknown leaderboard"
}