Leaderboard module

This module manages:

• GET Leaderboard
• GET Leaderboard types

It is located at https://api.wynncraft.com/v3/leaderboards

Get leaderboard

GET .../ 10 minutes TTL

# Guild Leaderboards
{
    "1": {
        "uuid": str,
        "name": str,
        "prefix": str,
        "xp": int,
        "territories": int,
        "wars": int,
        "level": int,
        "members": int,
        "created": str,
        "banner": {
            "base": str,
            "tier": int,
            "structure": str,
            "layers": [
                {
                    "colour": str,
                    "pattern": str
                },
                # [...]
            ]
        },
    },
    # [...]
}

# Player Leaderboards
{
    "1": {
        "name": str,
        "uuid": str,
        "score": int,
        "previousRanking": int,
        "metadata": {
            "xp": int,
            "playtime": float
        },
        "rankBadge": str,
        "supportRank": str,
        "shortenedRank": str,
        "legacyRankColor": {
            "sub": str,
            "main": str
        },
        "characterType": str,
        "characterUuid": str,
    },
    # [...]
}

# Gamemodes leaderboards
{
    "1": {
        "name": str,
        "uuid": str,
        "score": int,
        "previousRanking": int,
        "metadata": {
            "xp": int,
            "playtime": float
        },
        "rankBadge": str,
        "supportRank": str,
        "shortenedRank": str,
        "legacyRankColor": {
            "sub": str,
            "main": str
        },
        "characterType": str,
        "characterUuid": str,
        "characterData": dict,
    },
    # [...]
}

# Raids leaderboards
{
    "1": {
        "name": str,
        "uuid": str,
        "score": int,
        "previousRanking": int,
        "metadata": {
            "completions": int,
            "gambitsUsed": int,
        },

        # If player related leaderboard
        "rankBadge": str,
        "supportRank": str,
        "shortenedRank": str,
        "legacyRankColor": {
            "sub": str,
            "main": str
        },

        # If guild related leaderboard
        "banner": {
            "base": str,
            "tier": int,
            "structure": str,
            "layers": [
                {
                    "colour": str,
                    "pattern": str
                },
                # [...]
            ]
        },
    },
    # [...]
}

Request Playground

TIP

Leaderboard are updating each 10min for every player online, player going offline between the 10min interval are flagged to be updated as well on the next update.

You can use the query parameter resultLimit with an int bellow 1000 to limit the result to what ever number you want. Default limit is 100.

Player leaderboards have optional keys: characterUuid and characterType included if the lb_type is a leaderboard on solo characters (e.g. professions leaderboards or gamemodes leaderboards).

metadata contain variable keys depending on the leaderboard type

Some gamemode leaderboards includes characterData, it contains stats of the related character with the same structure as player stats character data

Raids leaderboards include a score + gambit used, it's calculation is simple: completion = 200 then add +10 / +20 / +30 for each gambits.

TIP

previousRanking is stored daily (depending on activity, if the player is not active the stored rank stay the same), simply doing current rank - previous rank gives player's progression in a leaderboard (it can be negative)

Leaderboard types

GET .../ 1 hour TTL

[
    "lbType",
    "lbType",
    # [...]
]

Request Playground

Use this list to know what leaderboard you can request in get leaderboard