Lobby HTTP API - Revision history

Nosejj at 20:38, 16 April 2018

2018-04-16T20:38:01Z

Jrgp at 10:02, 2 September 2017

2017-09-02T10:02:33Z

Jrgp: /* List all servers, with filters */

2017-09-01T08:15:51Z

‎List all servers, with filters

Jrgp at 08:15, 1 September 2017

2017-09-01T08:15:23Z

Jrgp at 08:10, 1 September 2017

2017-09-01T08:10:41Z

Jrgp at 08:08, 1 September 2017

2017-09-01T08:08:40Z

Jrgp at 07:57, 1 September 2017

2017-09-01T07:57:10Z

Jrgp at 07:55, 1 September 2017

2017-09-01T07:55:41Z

Jrgp: add http api docs

2017-09-01T07:54:22Z

add http api docs

New page

Recently, we added a standard json-based REST HTTP API to make getting the list of Soldat servers much easier for third party applications.

URL: http://api.soldat.pl (https is also supported)
CORS headers are present so this can be used via ajax.

== List all servers, with filters ==

http://api.soldat.pl/v0/servers

List all Soldat servers. You can provide a combination of these GET parameters as filters:

?os=linux|mac|windows
?gamestyle=DM|PM|TM|CTF|RM|INF|HTF
?country=US|DE|...
?version=1.7.1|1.6.1|...
?empty=yes|no
?full=yes|no
?bots=yes|no
?private=yes|no
?realistic=yes|no
?survival=yes|no
?advanced=yes|no

Example response:

{
"Servers": [
{
"AC": false,
"Advanced": false,
"BonusFreq": 0,
"ConnectionType": 3,
"Country": "FR",
"CurrentMap": "Blox",
"Dedicated": true,
"GameStyle": "DM",
"IP": "5.135.160.192",
"Info": "GamingCrew.pl",
"MaxPlayers": 5,
"Name": "GamingCrew.pl[1vs1]#2",
"NumBots": 0,
"NumPlayers": 0,
"OS": "linux",
"Port": 23078,
"Private": false,
"Realistic": false,
"Respawn": 0,
"Survival": false,
"Version": "1.7.1",
"WM": false
}]
}

== Get data on server ==

http://api.soldat.pl/v0/server/$ip/$port

Example response:

{
"AC": false,
"Advanced": false,
"BonusFreq": 0,
"ConnectionType": 3,
"Country": "US",
"CurrentMap": "Island2k5",
"Dedicated": true,
"GameStyle": "DM",
"IP": "207.152.134.13",
"Info": "Eat Moar Chik'n",
"MaxPlayers": 10,
"Name": "Drop a Penny",
"NumBots": 0,
"NumPlayers": 0,
"OS": "windows",
"Port": 23073,
"Private": false,
"Realistic": true,
"Respawn": 0,
"Survival": false,
"Version": "1.7.1",
"WM": false
}

== Get players for a server ==

http://api.soldat.pl/v0/server/$ip/$port/players

This will make the lobby use the file download protocol to grab that server's gamestat.txt file and parse and display the players currently in the server. FYI: This makes use of caching to prevent abuse.

Example response:

{
"Players": [
"/././a.d.i.d.a.s/././",
"Alvarez",
"Freedom Fighter",
"Guenther Gummibrot",
"summer camp",
"|TPF. GottenSikici"
]
}

@@ Line 4: / Line 4: @@
 * CORS headers are present so this can be used via ajax.
 * [https://forums.soldat.pl/index.php?topic=44915.0 Forum thread] where this was originally announced. Feel free to comment on this thread with feature requests.
 == List all servers, with filters ==
@@ Line 57: / Line 58: @@
+      ]
+  }
 == Get data on server ==
@@ Line 88: / Line 90: @@
      "WM": false
+  }
 == Get players for a server ==
@@ Line 107: / Line 110: @@
+     ]
+  }
 [[Category:Server]]

@@ Line 3: / Line 3: @@
 * URL: http://api.soldat.pl (https is also supported)
 * CORS headers are present so this can be used via ajax.
-* [https://forums.soldat.pl/index.php?topic=44915.0 Forum thread] where this was originally announced
+* [https://forums.soldat.pl/index.php?topic=44915.0 Forum thread] where this was originally announced. Feel free to comment on this thread with feature requests.
 == List all servers, with filters ==

@@ Line 1: / Line 1: @@
 Recently, we added a standard json-based REST HTTP API to make getting the list of Soldat servers much easier for third party applications, compared to the legacy [[Client-Lobby_Protocol]].
-URL: http://api.soldat.pl (https is also supported)
+* URL: http://api.soldat.pl (https is also supported)
-CORS headers are present so this can be used via ajax.
+* CORS headers are present so this can be used via ajax.
 == List all servers, with filters ==

← Older revision		Revision as of 07:57, 1 September 2017
Line 1:		Line 1:
−	Recently, we added a standard json-based REST HTTP API to make getting the list of Soldat servers much easier for third party applications.	+	Recently, we added a standard json-based REST HTTP API to make getting the list of Soldat servers much easier for third party applications, compared to the legacy [[Client-Lobby_Protocol]].

	URL: http://api.soldat.pl (https is also supported)		URL: http://api.soldat.pl (https is also supported)

← Older revision		Revision as of 07:55, 1 September 2017
Line 101:		Line 101:
	]		]
	}		}
		+
		+	[[Category:Server]]

@@ Line 9: / Line 9: @@
   http://api.soldat.pl/v0/servers
-List all Soldat servers. You can provide a combination of these GET parameters as filters:
+List all Soldat servers. You can provide a combination of the following GET parameters as filters. The pipes represent unique options, and the 3 dots represent other options which you can guess.
    ?os=linux|mac|windows

@@ Line 36: / Line 36: @@
              "BonusFreq": 0,
              "ConnectionType": 3,
-             "Country": "FR",
+             "Country": "US",
-             "CurrentMap": "Blox",
+             "CurrentMap": "ctf_Viet",
              "Dedicated": true,
-             "GameStyle": "DM",
+             "GameStyle": "CTF",
-             "IP": "5.135.160.192",
+             "IP": "108.61.204.90",
-             "Info": "GamingCrew.pl",
+             "Info": "~ facebook.com/AUS7RAL12 | #austral12soldat @ Qnet",
-             "MaxPlayers": 5,
+             "MaxPlayers": 12,
-             "Name": "GamingCrew.pl[1vs1]#2",
+             "Name": "=AUS7RAL|12 OneShots",
              "NumBots": 0,
-             "NumPlayers": 0,
+             "NumPlayers": 1,
              "OS": "linux",
-             "Port": 23078,
+             "Port": 23075,
              "Private": false,
              "Realistic": false,
@@ Line 54: / Line 54: @@
              "Version": "1.7.1",
              "WM": false
          }]
+  }

@@ Line 22: / Line 22: @@
    ?survival=yes|no
    ?advanced=yes|no
 Example response: