Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[GET] /community/leaderboard/getRecentMatchHistory

Example request

Returns the recent match history for one or more players. You must provide at least one of profile_names, profile_ids, or aliases.

Request

parametertypevaluecomments
titlestr/enumage1, age2, age3, age4Game title
profile_namesarray[str]e.g. [“/steam/<steam_id>”]Platform-prefixed player IDs
profile_idsarray[int]e.g. [“<relic_link_id>”]Relic link profile IDs
aliasesarray[str]e.g. [BlackRock]In-game display names

Response

AoE2:DE

The response contains a matchHistoryStats array of match objects and a profiles array with player metadata. Each match includes a matchhistoryreportresults array with per-player results, and optionally matchurls with replay download links.

{
    "result": {
        "code": 0,
        "message": "SUCCESS"
    },
    "matchHistoryStats": [
        {
            "id": 183556359,
            "creator_profile_id": 199325,
            "mapname": "FrigidLake.rms",
            "maxplayers": 2,
            "matchtype_id": 26,
            "options": "eNpFUtFugzAM/Jd9waAQqY+p...",
            "slotinfo": "eNq9kFFPgzAUhf0tfa5mFDVh...",
            "description": "AUTOMATCH",
            "startgametime": 1664802149,
            "completiontime": 1664802709,
            "observertotal": 4,
            "matchhistoryreportresults": [
                {
                    "matchhistory_id": 183556359,
                    "profile_id": 199325,
                    "resulttype": 0,
                    "teamid": 0,
                    "race_id": 29,
                    "xpgained": 1,
                    "counters": "{}",
                    "matchstartdate": 1664802149
                },
                {
                    "matchhistory_id": 183556359,
                    "profile_id": 196240,
                    "resulttype": 1,
                    "teamid": 1,
                    "race_id": 12,
                    "xpgained": 1,
                    "counters": "{}",
                    "matchstartdate": 1664802149
                }
            ],
            "matchhistorymember": [
                {
                    "matchhistory_id": 183556359,
                    "profile_id": 199325,
                    "race_id": 29,
                    "statgroup_id": 12345,
                    "teamid": 0,
                    "wins": 10,
                    "losses": 5,
                    "streak": 2,
                    "arbitration": 0,
                    "outcome": 0,
                    "oldrating": 1200,
                    "newrating": 1190,
                    "reporttype": 0
                }
            ],
            "matchhistoryitems": [],
            "matchurls": []
        }
    ],
    "profiles": [
        {
            "profile_id": 196240,
            "name": "/steam/76561197984749679",
            "alias": "GL.TheViper",
            "personal_statgroup_id": 200,
            "xp": 3091,
            "level": 2,
            "leaderboardregion_id": 0,
            "country": "de"
        }
    ]
}

Match object fields

fieldtypedescription
idintUnique match ID
creator_profile_idintProfile ID of the player who created the lobby
mapnamestringMap filename (e.g. FrigidLake.rms)
maxplayersintMaximum number of player slots
matchtype_idintMatch type identifier (e.g. 26 = 1v1 ranked)
optionsstringBase64-encoded zlib-compressed match options
slotinfostringBase64-encoded zlib-compressed slot configuration
descriptionstringLobby description (AUTOMATCH for ranked)
startgametimeintMatch start time (Unix timestamp)
completiontimeintMatch end time (Unix timestamp)
observertotalintNumber of observers in the match
matchhistoryreportresultsarrayPer-player result entries (see below)
matchhistorymemberarrayPer-player rating/ELO data (see below)
matchhistoryitemsarrayIn-game items (typically empty)
matchurlsarrayReplay file download URLs (when available)

matchhistoryreportresults entry fields

fieldtypedescription
matchhistory_idintMatch ID (same as parent match id)
profile_idintPlayer’s profile ID
resulttypeint0 = loss, 1 = win
teamidintTeam index (0-based)
race_idintCivilization ID (see reference tables)
xpgainedintExperience points gained from the match
countersstringJSON string of in-game counters (often "{}")
matchstartdateintMatch start time (Unix timestamp, same as parent)

matchhistorymember entry fields

fieldtypedescription
matchhistory_idintMatch ID (same as parent match id)
profile_idintPlayer’s profile ID
race_idintCivilization ID
statgroup_idintPlayer’s stat group ID
teamidintTeam index (0-based)
winsintPlayer’s total wins in this mode
lossesintPlayer’s total losses in this mode
streakintCurrent win/loss streak
arbitrationintArbitration status
outcomeintMatch outcome for this player
oldratingintELO rating before the match
newratingintELO rating after the match
reporttypeintType of result report

profiles entry fields

fieldtypedescription
profile_idintPlayer’s profile ID
namestringPlatform-prefixed ID (e.g. /steam/<steam_id>)
aliasstringIn-game display name
personal_statgroup_idintPlayer’s personal stat group ID
xpintTotal experience points
levelintPlayer level
leaderboardregion_idintRegion ID (0 = Europe, 2 = Asia, etc.)
countrystringTwo-letter country code

Note: The options and slotinfo fields contain base64-encoded, zlib-compressed data. Decode with base64 then decompress with zlib to access the underlying configuration.