OGame provides two different types of API: a public API, and a non-public, access-controlled API.
Public API
The public API provides data about universes and their players and is updated at fixed intervals depending on the endpoint.
To check the API of another server, you just need to change the s1-en part of the URL to the server you want to check, for example s122-de.
If the universe you want to check is a universe with a number as its name, there will be no <name></name> entry in the serverData API.
In order to retrieve the data as JSON instead of XML, append ?toJson=1 to the URL.
https://s1-en.ogame.gameforge.com/api/highscore.xml - Updates once an hour (possible parameters)
https://s1-en.ogame.gameforge.com/api/players.xml - Updates once a day
https://s1-en.ogame.gameforge.com/api/alliances.xml - Updates once a day
https://s1-en.ogame.gameforge.com/api/universe.xml - Updates once a week
https://s1-en.ogame.gameforge.com/api/serverData.xml - Updates once a day
https://s1-en.ogame.gameforge.com/api/playerData.xml - Updates once a week
https://s1-en.ogame.gameforge.com/api/localization.xml -> Tech IDs (Buildings, Research, Ships, Defence, Mission types) and their localization
https://s1-en.ogame.gameforge.com/api/universes.xml -> List of all universes of a community
Non-universe-specific APIs
https://lobby.ogame.gameforge.com/api/servers - List of all universes accessible via the Lobby with a short excerpt of their settings
Non-public API
This API is access-controlled. In order to access these endpoints, you must request access in the Submissions & API Requests sub-forum. Please refer to the pinned threads there for details on the application process.
Once access has been granted, you will receive an API access key. This key must be kept private and is required for every request to the non-public API.
Review this thread for more details about these endpoints.
Reports API
In the game, certain reports (combat reports, espionage reports, recycler reports, missile reports) contain an API string. This string is accessible via the "API" button shown in the report message tooltip.
An example API string looks like this: cr-en-1-5c36288ad220f5d68845c6bdd90bad979aff6409
This string consists of four parts:
- the type of the report (cr, sr, rr, mr)
- the community (en)
- the server number (1)
- the report ID (20 hexadecimal characters, e.g. 5c36288ad220f5d68845c6bdd90bad979aff6409)
Using these values and your API access key, you can retrieve the report data via the following endpoints:
Combat Report (CR):
https://s<SERVERNUMBER>-<COMMUNITY>.ogame.gameforge.com/api/v1/combat/report?api_key=<API-KEY>&cr_id=<ID>
Espionage Report (SR):
https://s<SERVERNUMBER>-<COMMUNITY>.ogame.gameforge.com/api/v1/spy/report?api_key=<API-KEY>&sr_id=<ID>
Recycler Report (RR):
https://s<SERVERNUMBER>-<COMMUNITY>.ogame.gameforge.com/api/v1/recycle/report?api_key=<API-KEY>&rr_id=<ID>
Missile Report (MR):
https://s<SERVERNUMBER>-<COMMUNITY>.ogame.gameforge.com/api/v1/missile/report?api_key=<API-KEY>&mr_id=<ID>
Statistics API
In addition to report retrieval, the statistics API allows access to historical ranking data.
https://s<SERVERNUMBER>-<COMMUNITY>.ogame.gameforge.com/api/v1/statistics/generic/?api_key=<API-KEY>&startdate=<YYYY-MM-DD>&delta=<DELTA>
The startdate must be in the format YYYY-MM-DD. The maximum allowed value for delta is 50.
