List Games

The list games API can return detailed information about all games on the Planets Nu website or for an individual player. This API is a public API and does not require authentication.

The most basic usage is just to make a GET call from http://api.planets.nu/games/list

Each game record will be returned in a JSON array and appears as an array of game objects:

[{game 1},{game 2},{game 3}]

Where each game object has many properties.

Subsequent filters can be applied by query-string parameter:

Status

1 - Joining
2 - Running
3 - Finished
4 - Hold
Default: 1,2

Type

1 - Training
2 - Standard
3 - Team
4 - Melee
5 - Blitz
Default: 2,3,4

Scope

0 - Public
1 - Custom (private games)
Default: 0

Ids

ids - comma separated list of game ids
Will return the game records for these ids

Username

username - Username of the account to list games
Will list all games for this user regardless of other settings

Limit

limit - the max number of records to return
Default: 0 (all records)

For example:

http://api.planets.nu/games/list?scope=0&status=1,2&type=2,3,4

Would return all public standard games which are currently running or joining.

http://api.planets.nu/games/list?username=joshua

Would return all the currently active games for joshua's account. For username's which have spaces or special characters be sure to URL Encode your request.

http://api.planets.nu/games/list?ids=815,1000

Would return the game records for game 815 and game 1000.

Important note: The response is GZIP compressed and must be decompressed after downloading. (Browsers do this automatically but most code libraries do not)