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

API Reference - Constants & Enums

This page provides a quick reference for all IDs and constants used in the WorldsEdgeLink API.

Source: These values are extracted from the API responses of /community/leaderboard/GetAvailableLeaderboards and /game/automatch2/getAutomatchMap.

Leaderboards

IDNameDescription
1SOLO_DM_RANKED1v1 Death Match
2TEAM_DM_RANKEDTeam Death Match (2v2, 3v3, 4v4)
3SOLO_RM_RANKED1v1 Random Map
4TEAM_RM_RANKEDTeam Random Map (2v2, 3v3, 4v4)
5SOLO_BR_RANKEDBattle Royale (FFA)
13SOLO_EW_RANKED1v1 Empire Wars
14TEAM_EW_RANKEDTeam Empire Wars (2v2, 3v3, 4v4)

Match Types

IDNameMode
21V1Death Match
32V2Death Match
43V3Death Match
54V4Death Match
61V1Random Map
72V2Random Map
83V3Random Map
94V4Random Map
10FFABattle Royale
261V1Empire Wars
272V2Empire Wars
283V3Empire Wars
294V4Empire Wars
60CUSTOM_DM_1v1Custom Death Match 1v1
61CUSTOM_DM_TEAMCustom Death Match Team

Civilizations (Races)

IDName
0Aztecs
1Berbers
2Britons
3Bulgarians
4Burmese
5Byzantines
6Celts
7Chinese
8Cumans
9Ethiopians
10Franks
11Goths
12Huns
13Incas
14Hindustanis
15Italians
16Japanese
17Khmer
18Koreans
19Lithuanians
20Magyars
21Malay
22Malians
23Mayans
24Mongols
25Persians
26Portuguese
27Saracens
28Slavs
29Spanish
30Tatars
31Teutons
32Turks
33Vietnamese
34Vikings
35Burgundians
36Sicilians
37Poles
38Bohemians
39Bengalis
40Dravidians
41Gurjaras

Note: Civilization IDs may shift when new DLCs are released. See the Changelog for historical changes.

Leaderboard Regions

IDName
0Europe
1Middle East
2Asia
3North America
4South America
5Oceania
6Africa
7Unknown

Maps (Selection)

Common ranked maps:

IDFilenameMap Name
1AfricanClearing.rmsAfrican Clearing
2Arabia.rmsArabia
3Arena.rmsArena
4FourLakes.rmsFour Lakes
5Islands.rmsIslands
6nomad.rmsNomad
7Yucatan.rmsYucatan
14Black_Forest.rmsBlack Forest
17Fortress.rmsFortress
20Mediterranean.rmsMediterranean
23megarandom.rms2Mega Random
26Michi.rmsMichi
29Nile Delta.rmsNile Delta
36Ghost_Lake.rmsGhost Lake
37goldenpit.rms2Golden Pit
38GoldenSwamp.rmsGolden Swamp
39Kilimanjaro.rmsKilimanjaro
40valley.rms2Valley
41acropolis.rms2Acropolis
43Serengeti.rmsSerengeti

Note: Map IDs vary by match type (1v1, 2v2, etc.). The full list is available in the getAutomatchMap endpoint.

Game Titles

ValueGame
age1Age of Empires: Definitive Edition
age2Age of Empires II: Definitive Edition
age3Age of Empires III: Definitive Edition
age4Age of Empires IV

Platforms

ValuePlatform
PC_STEAMSteam
PC_WINDOWS_STOREMicrosoft Store / Xbox

Result Codes

CodeMessageDescription
0SUCCESSRequest successful
-1FAILEDGeneric failure
2INVALID_SESSIONSession expired, re-authenticate

HTTP Status Codes

CodeMeaningAction
200OKRequest successful
429Too Many RequestsRate limited - back off and retry
403ForbiddenInvalid or expired session

Rate Limits

APILimitRecommendation
Community API50 req/secSafe for most use cases
Game API~200 req/minUse 100 req/30 sec for safety

See Usage Guidelines for more details.