API games list

Overview of /games/list API call

The /games/list API call is used to get a list of games that match a search pattern.

The data returned by this call is fairly limited, but it does include a list of gameids that matches the search pattern. These gameids can then be used to collect more information with other calls as needed.

Examples of searches that you can perform with this call:

• a list of all games running
• a list of games that a particular user is in
• a list of running/finished championship games
• a list of team games in joining stage
• a list of finished classic / standard games

It can't be used directly to do more complex searches such as:

• running games with x open spots
• running games with >x campaign points
• joining games of difficulty modifier >x
• joining games with an open fed/liz/xxx space

For these more complex searches you would have to get all games fitting the general search pattern, and then write a script to filter down to your exact match.

This is a public API call and does not require an apikey.

Data sent

Data	Description
username (optional)	Find all games with username in. (Encode spaces and non-alphanumeric characters). (Ignores all other search terms).
ids (optional)	Find games by gameid(s). (Comma separated if multiple). (Ignores all other search terms).
status (optional)	0.  Interest 1.  Joining 2.  Running 3.  Finished 4.  On Hold (Comma separated if multiple). (Default= "1,2")
type (optional)	Training Classic / Standard / Custom Team / Mentor vs. Midshipmen Giant Melee Blitz Championship Academy (Comma separated if multiple). (Default= "2,3,4")
scope (optional)	0= Public 1= Custom/Private (Comma separated if multiple). (Default= "0")
limit (optional)	Maximum number of games to return. (Default= 0 = all)

Notes

Using the "username" or "ids" property ignores the other properties.

The "ids" property takes precedence over the "username" property.

Data returned

Data	Description
array of Game objects.	(Array can be empty if no matching games are found).

Game Object

Failures

{"success":false,"error":"Game Ids in incorrect format"}

Back