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: Running (2)
type: 1 - Training, 2 - Standard, 5 - Blitz Default: Standard (2)
scope: 1 - Public, 2 - Custom Default: Public (1)
username: joshua - Username of the account to list games - Will change above defaults to: status = running, type = all, scope = all unless otherwise specified.

For example:

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

Would return all public standard games which are currently running.

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.

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