This is an old revision of the document!
WorldsEdgeLink API
Age of Empires API Usage Guidelines
Rate Limits and Access Patterns - The game API has rate limits of approximately 200 requests per minute - Rate limit violations trigger a 429 HTTP error - Recommended configuration: Implement a throttler at 100 requests per 30 seconds for safety
Recommended Access Patterns
- Safe to access:
- Ongoing games
- Match histories
- Leaderboards
Optimization Strategy
Use a dual-API approach: 1. Game API
- Primary use: Fetching ongoing observable games
- Expected usage: 10-15 requests per minute
2. Community API
- Use for match histories and leaderboards
- Benefits from higher rate limits
- Reduces load on main game API
Actions to Avoid
- Accessing chat channels - Accessing presence-related features - Making POST requests - Creating lobbies via API - Any other write operations
Error Handling
Implement logging for rate limit errors (HTTP 429) to monitor API usage patterns
API Root
Endpoints
Recorded games
https://aoe.ms/replay/?gameId=<game_id>&profileId=<profile_id>
| parameter | type | value | comments |
|---|---|---|---|
| gameId | int64 | 156900198 | |
| profileId | int64 | 2858362 | |
Where <profile_id> is the perspective of the recorded game. Basically from which client it was uploaded. Matters for view lock.
Authentication
Check our Authentication Helper
General Notes
Some stuff is zlib-compressed. E.g. inside
slotinfo
there's a
metaData
field that seem to be a two-pass base64 string holding binary data Couldn't deduce options yet. It's zlib as well, but the uncompressed string looks different, it's not base64(?)