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/CommunityEvent/getAvailableCommunityEvents

Example request

Request

parametertypevaluecomments
titlestr/enumage1, age2, age3, age4

Response

AoE2:DE

Returns currently active or recently ended community events (e.g. sponsored tournaments with special leaderboards). The array is empty when no events are active.

{
    "result": {
        "code": 0,
        "message": "SUCCESS"
    },
    "communityEvents": [
        {
            "id": 57,
            "name": "Red Bull Wololo: Londinium",
            "start": 1767372900,
            "end": 1768755600,
            "expiryTime": 1777651200,
            "scheduledstarttime": 1767372900,
            "scheduledendtime": 1768755600,
            "scheduledexpirytime": 1777651200,
            "actualstarttime": 1767372910,
            "actualendtime": 1768755675,
            "customdata": "{\"ClientData\":{\"MatchTypeOverride\":[{\"current\":26,\"override\":124,\"leaderboard\":29,\"gamemode\":13,\"victoryType\":7,\"leaderboard-string\":\"IDS_MATCHMAKING_RED_BULL\",\"leaderboard-warning-string\":\"IDS_LEADERBOARD_RANKED_WARNING_RED_BULL_WOLOLO\",\"match-type-name\":[\"RBW_LONDINIUM\",\"IDS_MATCHMAKING_SPONSORED_TOURNAMENT\"],\"crossplay\":true,\"console\":false},{\"current\":86,\"override\":125,\"leaderboard\":30,\"gamemode\":13,\"victoryType\":7,\"leaderboard-string\":\"IDS_MATCHMAKING_RED_BULL_CO\",\"leaderboard-warning-string\":\"IDS_LEADERBOARD_RANKED_WARNING_RED_BULL_WOLOLO\",\"match-type-name\":[\"RBW_LONDINIUM\",\"IDS_MATCHMAKING_SPONSORED_TOURNAMENT\"],\"crossplay\":false,\"console\":true}],\"TournamentMode\":true}}",
            "eventstate": 2
        }
    ],
    "leaderboards": [],
    "leaderboardMaps": [],
    "rankLevels": []
}
fieldtypedescription
idintEvent ID
namestringDisplay name of the event
startintUnix timestamp for event start
endintUnix timestamp for event end
expiryTimeintUnix timestamp when event data expires
scheduledstarttimeintOriginally scheduled start time
scheduledendtimeintOriginally scheduled end time
actualstarttimeintActual start time (may differ from scheduled)
actualendtimeintActual end time
customdatastringJSON-encoded client config (match type overrides, etc)
eventstateintEvent state (2 = ended)