Query game API - Revision history

Fizzer at 02:35, 18 April 2026

2026-04-18T02:35:58Z

← Older revision		Revision as of 02:35, 18 April 2026
Line 1:		Line 1:
	~~Warzone~~ can provide programmatic access to the details about multi-player ~~Warzone~~ games. This allows for the more technical users to write a program that can analyze information about games. This data is only available for ladder games, tournament games, games created by the [[Create game API]], or games that you played in.		War.app can provide programmatic access to the details about multi-player War.app games. This allows for the more technical users to write a program that can analyze information about games. This data is only available for ladder games, tournament games, games created by the [[Create game API]], or games that you played in.

	There's nothing the feed can see that isn't already available through the game's normal interface. This is just a way to write custom analyzers which allows for a broader analysis across games.		There's nothing the feed can see that isn't already available through the game's normal interface. This is just a way to write custom analyzers which allows for a broader analysis across games.
Line 7:		Line 7:
	==Usage==		==Usage==

	To access the data, use a URL like this: https://www.~~warzone~~.~~com~~/API/GameFeed?GameID=1212978		To access the data, use a URL like this: https://www.war.app/API/GameFeed?GameID=1212978

	This will return data describing basic details(id, state, name, numberOfTurns, lastTurnTime, templateID, players) about the game.		This will return data describing basic details(id, state, name, numberOfTurns, lastTurnTime, templateID, players) about the game.
Line 54:		Line 54:
	==Getting a list of Game IDs==		==Getting a list of Game IDs==

	In order to use the game feed, you'll need to know the game ID. This can be obtained through the graphical ~~Warzone~~ client by opening up the Settings panel and examining the "Link to Game" field. At the end of this field, you'll see GameID= followed by a number.		In order to use the game feed, you'll need to know the game ID. This can be obtained through the graphical War.app client by opening up the Settings panel and examining the "Link to Game" field. At the end of this field, you'll see GameID= followed by a number.

	To find game IDs programmatically, you can use the [[Game ID feed API]].		To find game IDs programmatically, you can use the [[Game ID feed API]].

JustADutchman: /* JSON Definition */

2025-06-05T20:28:54Z

JSON Definition

← Older revision		Revision as of 20:28, 5 June 2025
Line 24:		Line 24:
	In the JSON, you'll find:		In the JSON, you'll find:
	* The players in the game (their names, color, their state, etc.)		* The players in the game (their names, color, their state, etc.)
	* All of the details of the map (it's name, all of its territories ~~and~~ what they connect to, all of its bonuses and what territories are in each bonus)		* All of the details of the map (it's name, all of its territories, what they connect to and their x/y coordinates, all of its bonuses and what territories are in each bonus)
	* The '''distribution standing''': This is what the map looked like when it was time to pick the territories you started with. This is only present for manual distribution games.		* The '''distribution standing''': This is what the map looked like when it was time to pick the territories you started with. This is only present for manual distribution games.
	* The picks: This tells you which territories each player picked, and in what order. Like the distribution standing, this is only present for manual distribution games.		* The picks: This tells you which territories each player picked, and in what order. Like the distribution standing, this is only present for manual distribution games.
	* Standing 0: This tells you what the map looked like at the beginning of the game.		* Standing 0: This tells you what the map looked like at the beginning of the game.
	* Turn 0: This is all of the orders that played out on the first turn of the game.		* Turn 0: This is all of the orders that played out on the first turn of the game.
	* Standing x/turn x: Standings and turns then alternate for each turn of the game, all the way until the final standing.		* Standing x/turn x: Standings and turns then alternate for each turn of the game, all the way until the final standing.

	== Game State ==		== Game State ==

Fizzer at 16:01, 25 May 2023

2023-05-25T16:01:39Z

← Older revision		Revision as of 16:01, 25 May 2023
Line 13:		Line 13:
	If you want to get the entire turn history of the game, add an additional querystring parameter '''GetHistory=true'''. Adding this will cause the API to return you details about every turn of the game assuming it's finished.		If you want to get the entire turn history of the game, add an additional querystring parameter '''GetHistory=true'''. Adding this will cause the API to return you details about every turn of the game assuming it's finished.

	If you want to get a game's settings, add an additional querystring parameter '''~~Settings~~=true'''. Adding this will cause the API to return you details about the settings of the game.		If you want to get a game's settings, add an additional querystring parameter '''GetSettings=true'''. Adding this will cause the API to return you details about the settings of the game.

	If you want to get a game's public chat message, add an additional querystring parameter '''GetChat=true'''.		If you want to get a game's public chat message, add an additional querystring parameter '''GetChat=true'''.

JK 3: Updated Settings parameter and added GetChat

2023-05-25T15:58:11Z

Updated Settings parameter and added GetChat

← Older revision		Revision as of 15:58, 25 May 2023
Line 13:		Line 13:
	If you want to get the entire turn history of the game, add an additional querystring parameter '''GetHistory=true'''. Adding this will cause the API to return you details about every turn of the game assuming it's finished.		If you want to get the entire turn history of the game, add an additional querystring parameter '''GetHistory=true'''. Adding this will cause the API to return you details about every turn of the game assuming it's finished.

	If you want to get a game's settings, add an additional querystring parameter '''~~GetSettings~~=true'''. Adding this will cause the API to return you details about the settings of the game.		If you want to get a game's settings, add an additional querystring parameter '''Settings=true'''. Adding this will cause the API to return you details about the settings of the game.

			If you want to get a game's public chat message, add an additional querystring parameter '''GetChat=true'''.

	==JSON Definition==		==JSON Definition==

Fizzer at 13:56, 19 May 2021

2021-05-19T13:56:05Z

← Older revision		Revision as of 13:56, 19 May 2021
Line 2:		Line 2:

	There's nothing the feed can see that isn't already available through the game's normal interface. This is just a way to write custom analyzers which allows for a broader analysis across games.		There's nothing the feed can see that isn't already available through the game's normal interface. This is just a way to write custom analyzers which allows for a broader analysis across games.

			The primary goals of this API is to enable tools that do statistical analysis of finished games and to enable custom ladders or custom tournaments to check on the winners of the game after it's over.

	==Usage==		==Usage==
Line 9:		Line 11:
	This will return data describing basic details(id, state, name, numberOfTurns, lastTurnTime, templateID, players) about the game.		This will return data describing basic details(id, state, name, numberOfTurns, lastTurnTime, templateID, players) about the game.

	If you want to get the entire turn history of the game, add an additional querystring parameter '''GetHistory=true'''. Adding this will cause the API to return you details about every turn of the game.		If you want to get the entire turn history of the game, add an additional querystring parameter '''GetHistory=true'''. Adding this will cause the API to return you details about every turn of the game assuming it's finished.

	If you want to get a game's settings, add an additional querystring parameter '''GetSettings=true'''. Adding this will cause the API to return you details about the settings of the game.		If you want to get a game's settings, add an additional querystring parameter '''GetSettings=true'''. Adding this will cause the API to return you details about the settings of the game.

Fizzer at 15:50, 11 April 2020

2020-04-11T15:50:19Z

← Older revision		Revision as of 15:50, 11 April 2020
Line 47:		Line 47:
	* Declined: This player declined the game and did not play.		* Declined: This player declined the game and did not play.
	* RemovedByHost: This player was removed by the host via the "Add/Remove Players" button and did not play. If you created the game via the Create Game API, you don't have to worry about this state since you're the host, and only you could remove players.		* RemovedByHost: This player was removed by the host via the "Add/Remove Players" button and did not play. If you created the game via the Create Game API, you don't have to worry about this state since you're the host, and only you could remove players.

	~~Each finished game is guaranteed to have at least one player with a Won state or a VotedToEnd state.~~

	==Getting a list of Game IDs==		==Getting a list of Game IDs==

Fizzer at 15:49, 11 April 2020

2020-04-11T15:49:22Z

← Older revision		Revision as of 15:49, 11 April 2020
Line 44:		Line 44:
	* Booted: This player was booted from the game.		* Booted: This player was booted from the game.
	* Won: This player has won the game. This state will only be present in games that have finished.		* Won: This player has won the game. This state will only be present in games that have finished.
	* EndedByVote: This player, along with the other remaining players in the game, have voted to end the game.		* EndedByVote: This player, along with the other remaining players in the game, have voted to end the game. This state will only ever be present for games that are finished by voting-to-end.
	* Declined: This player declined the game and did not play.		* Declined: This player declined the game and did not play.
	* RemovedByHost: This player was removed by the host via the "Add/Remove Players" button and did not play. If you created the game via the Create Game API, you don't have to worry about this state since you're the host, and only you could remove players.		* RemovedByHost: This player was removed by the host via the "Add/Remove Players" button and did not play. If you created the game via the Create Game API, you don't have to worry about this state since you're the host, and only you could remove players.

Fizzer: Usage block is not the correct place for this information, as this just explains how to use the API not defining a subtle part of one field of its return

2019-10-04T21:15:33Z

Usage block is not the correct place for this information, as this just explains how to use the API not defining a subtle part of one field of its return

← Older revision		Revision as of 21:15, 4 October 2019
Line 7:		Line 7:
	To access the data, use a URL like this: https://www.warzone.com/API/GameFeed?GameID=1212978		To access the data, use a URL like this: https://www.warzone.com/API/GameFeed?GameID=1212978

	This will return data describing basic details(id, state, name, numberOfTurns, lastTurnTime*, templateID, players) about the game.		This will return data describing basic details(id, state, name, numberOfTurns, lastTurnTime, templateID, players) about the game.

	~~<nowiki>*</nowiki> - lastTurnTime is the timestamp of the last turn or the game finish date~~

	If you want to get the entire turn history of the game, add an additional querystring parameter '''GetHistory=true'''. Adding this will cause the API to return you details about every turn of the game.		If you want to get the entire turn history of the game, add an additional querystring parameter '''GetHistory=true'''. Adding this will cause the API to return you details about every turn of the game.

Fizzer at 03:39, 13 November 2017

2017-11-13T03:39:31Z

← Older revision		Revision as of 03:39, 13 November 2017
Line 1:		Line 1:
	~~WarLight~~ can provide programmatic access to the details about multi-player ~~WarLight~~ games. This allows for the more technical users to write a program that can analyze information about games. This data is only available for ladder games, tournament games, games created by the [[Create game API]], or games that you played in.		Warzone can provide programmatic access to the details about multi-player Warzone games. This allows for the more technical users to write a program that can analyze information about games. This data is only available for ladder games, tournament games, games created by the [[Create game API]], or games that you played in.

	There's nothing the feed can see that isn't already available through the game's normal interface. This is just a way to write custom analyzers which allows for a broader analysis across games.		There's nothing the feed can see that isn't already available through the game's normal interface. This is just a way to write custom analyzers which allows for a broader analysis across games.
Line 5:		Line 5:
	==Usage==		==Usage==

	To access the data, use a URL like this: https://www.~~warlight~~.~~net~~/API/GameFeed?GameID=1212978		To access the data, use a URL like this: https://www.warzone.com/API/GameFeed?GameID=1212978

	This will return data describing basic details(id, state, name, numberOfTurns, lastTurnTime*, templateID, players) about the game.		This will return data describing basic details(id, state, name, numberOfTurns, lastTurnTime*, templateID, players) about the game.
Line 54:		Line 54:
	==Getting a list of Game IDs==		==Getting a list of Game IDs==

	In order to use the game feed, you'll need to know the game ID. This can be obtained through the graphical ~~WarLight~~ client by opening up the Settings panel and examining the "Link to Game" field. At the end of this field, you'll see GameID= followed by a number.		In order to use the game feed, you'll need to know the game ID. This can be obtained through the graphical Warzone client by opening up the Settings panel and examining the "Link to Game" field. At the end of this field, you'll see GameID= followed by a number.

	To find game IDs programmatically, you can use the [[Game ID feed API]].		To find game IDs programmatically, you can use the [[Game ID feed API]].

Master of the Dead: /* Usage */

2017-08-04T06:17:06Z

Usage

← Older revision		Revision as of 06:17, 4 August 2017
Line 7:		Line 7:
	To access the data, use a URL like this: https://www.warlight.net/API/GameFeed?GameID=1212978		To access the data, use a URL like this: https://www.warlight.net/API/GameFeed?GameID=1212978

	This will return data describing basic details about the game.		This will return data describing basic details(id, state, name, numberOfTurns, lastTurnTime*, templateID, players) about the game.

			<nowiki>*</nowiki> - lastTurnTime is the timestamp of the last turn or the game finish date

	If you want to get the entire turn history of the game, add an additional querystring parameter '''GetHistory=true'''. Adding this will cause the API to return you details about every turn of the game.		If you want to get the entire turn history of the game, add an additional querystring parameter '''GetHistory=true'''. Adding this will cause the API to return you details about every turn of the game.