The War API allows developers to query information about the state of the current Foxhole World Conquest.
All data returned by the API is JSON. The API is accessed only via HTTPS.
The base of all API requests is /api. In this documentation all API endpoints will be specified relative to this root.
The root endpoints for each shard are:
| Shard | Root Endpoint URL |
|---|---|
| Live-1 | https://war-service-live.foxholeservices.com/api |
| Live-2 | https://war-service-live-2.foxholeservices.com/api |
| Live-3 | https://war-service-live-3.foxholeservices.com/api |
When the dev branch is active, its API will be available at: https://war-service-dev.foxholeservices.com/api. In general, any data
from this endpoint should not be considered final, and is subject to change frequently.
GET /worldconquest/war
Returns data about the current state of the war.
Field descriptions:
warId: unique id for the war.warNumber: current war number for the shard.winner: one ofNONE,WARDENS, orCOLONIALS.conquestStartTime: unix time stamp for when conquest started, or null if it hasn't started yet.conquestEndTime: unix time stamp for when conquest ended, or null if it hasn't ended yet.resistanceStartTime: unix time stamp for when resistance phase started, or null if it hasn't started yet.requiredVictoryTowns: number of victory towns required to win the war.
The number of required victory towns that's returned by this endpoint represents a static configuration value and does not take any scorched victory towns into account. This means that if you wish to determine how many victory towns are required to win the war, you must reduce it by one for each scorched victory town. A scorched victory town is any map item that has both the IsVictoryBase and IsScorched flags set. See the Map Data section for more details.
{
"warId" : "9b33b555-e587-4915-89a5-50eb37f2949d",
"warNumber" : 33,
"winner" : "NONE",
"conquestStartTime" : 1563291629686,
"conquestEndTime" : null,
"resistanceStartTime" : null,
"requiredVictoryTowns" : 20
}
This data may update every 60 seconds.
GET /worldconquest/maps
Returns a list of the active World Conquest map names.
Note: The maps HomeRegionC and HomeRegionW are returned here, but do not have map data available in this version.
GET /worldconquest/warReport/:mapName
Returns the number of enlistments, casualties, and other map specific information.
{
"totalEnlistments" : 148,
"colonialCasualties" : 202,
"wardenCasualties" : 222,
"dayOfWar" : 2
}
This data may update every 3 seconds.
GET /worldconquest/maps/:mapName/static
Static map data includes things that never change over the lifecycle of a map. This includes map text labels, resource nodes, and world structures.
You only need to request this once per map between World Conquests.
GET /worldconquest/maps/:mapName/dynamic/public
Dynamic map data includes map icons that could change over the lifecycle of a map. This includes static bases and static base build sites.
Team-specific data and forward bases are excluded.
This data may update every 3 seconds.
All endpoints that return map data have the same response format:
GET /worldconquest/maps/:mapName/static
{
"regionId" : 1,
"scorchedVictoryTowns": 0,
"mapItems" : [ {
"teamId" : "NONE",
"iconType" : 22,
"x" : 0.21965122,
"y" : 0.6231655,
"flags" : 0
},
...
],
"mapTextItems" : [ {
"text" : "Abandoned Ward",
"x" : 0.410076,
"y" : 0.4957782,
"mapMarkerType": "Major"
},
...
],
"lastUpdated" : 1524672871955,
"version" : 2
}
World Extents:
The minimum and maximum in-game world units. Used for mapping normalized coordinates to in-game coordinates.
WorldExtent.Minimum = (-109199.999997, -94499.99999580906968410989)
WorldExtent.Maximum = (109199.999997, 94499.99999580906968410989)
Note: The previous field worldExtents* which was present in every map's data is now a constant and consistent value across all maps since they are all of the same size.
Field descriptions:
regionId: internal region ID for this maplastUpdated: timestamp in milliseconds from epoch of when this map was last updatedversion: version index, increments whenever this map data changes. Used for caching.
Map item fields:
teamId: one ofNONE,WARDENS, orCOLONIALS.iconType: the type of the map icon, see the Map Icons sectionx,y: normalized map coordinateflags: bitmask of flags that apply to this icon, see the Map Flags section
Map text item fields:
text: text string as it would appear on the map ingamex,y: normalized map coordinatemapMarkerType: "Major" or "Minor". Major markers form the basis of Region Zones. Minor markers simply indicate areas of interest on the map, but don't have major gameplay impact.
Static Base 1 (5) // Removed in Update 46
Static Base 2 (6) // Removed in Update 46
Static Base 3 (7) // Removed in Update 46
Forward Base 1 (8)
Forward Base 2 (9) // Removed in Update 50
Forward Base 3 (10) // Removed in Update 50
Hospital (11)
Vehicle Factory (12)
Armory (13) // Removed in previous update
Supply Station (14) // Removed in previous update
Workshop (15) // Removed in previous update
Manufacturing Plant (16) // Removed in previous update
Refinery (17)
Shipyard (18)
Tech Center (19) (Engineering Center in Update 37)
Salvage Field (20)
Component Field (21)
Fuel Field (22)
Sulfur Field (23)
World Map Tent (24)
Travel Tent (25)
Training Area (26)
Special Base (Keep) (27) Update 14
Observation Tower (28) Update 14
Fort (29) Update 14
Troop Ship (30) Update 14
Sulfur Mine (32) Update 16
Storage Facility (33) Update 17
Factory (34) Update 17
Garrison Station (35) Update 20
Ammo Factory (36) // Removed in previous update
Rocket Site (37) Update 20
Salvage Mine (38) Update 22
Construction Yard (39) Update 26
Component Mine (40) Update 26
Oil Well (41) // Removed in Update 50
Relic Base 1 (45) Update 32
Relic Base 2 (46) // Removed in Update 52 until further notice (use Relic Base 1)
Relic Base 3 (47) // Removed in Update 52 until further notice (use Relic Base 1)
Mass Production Factory (51) Update 35
Seaport (52) Update 37
Coastal Gun (53) Update 37
Soul Factory (54) Update 39
Town Base 1 (56) Update 46
Town Base 2 (57) // Removed in Update 52 until further notice (use Town Base 1)
Town Base 3 (58) // Removed in Update 52 until further notice (use Town Base 1)
Storm Cannon (59) Update 47
Intel Center (60) Update 47
Coal Field (61) Update 50
Oil Field (62) Update 50
Rocket Target (70) Update 54
Rocket Ground Zero (71) Update 54
Rocket Site With Rocket (72) Update 54
Facility Mine Oil Rig (75) Update 54
Weather Station (83) Update 57
Mortar House (84) Update 58
There might not necessarily be a Colonial/Warden version of an icon. In this case, it is recommended to use these colours for rendering Colonial and Warden versions of that icon.
Colonial
- (0.082283, 0.14996, 0.07036, 1.0)
- RGB: (21, 38, 18, 255)
- Hex Linear: 152612FF
- Hex SRGB: 516C4BFF
Warden
- (0.017642, 0.093059, 0.223228, 1.0)
- RGB: (4, 23, 57, 255)
- Hex Linear: 041739FF
- Hex SRGB: 245682FF
IsVictoryBase (0x01)
IsHomeBase (0x02) // Removed in Update 29
IsBuildSite (0x04)
IsScorched (0x10) Update 22
IsTownClaimed (0x20) Update 26
Any other map flags not listed here are for internal use only, and should not be relied upon as they may be removed at any time.
Rocket Site, Rocket Site With Rocket, Rocket Target, and Rocket Ground Zero are all public team based map icons that show up for both factions.
Rocket Site - Shows when a rocket site is present.
Rocket Site With Rocket - Shows when a rocket site has a rocket present.
Rocket Target - Shows when a rocket has targeted a location for launch.
Rocket Ground Zero - Shows when a rocket has hit the targeted location.
If you wish to write logic that corresponds to a rocket hitting a location, then relying on a Rocket Ground Zero appearing is the best option.
See Map Data Schema and Map Icons for more information.
We ask that you respect the caching headers as returned by the API. They reflect the lifetime of the data returned in the body of the request and requests sooner than the cache expiry will return the same data.
The API fully supports ETags.
API responses include the ETag header. When you make an API request, include the If-None-Match
header with the value of the ETag you last received from that endpoint. If the server returns 304 Not Modified,
then your cached data is still the latest version.
It is good practice to use the ETag, as even though the cache may have expired the underlying data may not have changed.
For example in the case of dynamic map data, if no bases have changed teams within 5 minutes, the cache will have
expired but requests using the ETag will return 304 Not Modified, preventing wasting bandwidth on duplicate data.
If you're looking for assistance or just want to chat about the WarAPI, there is a discord channel called code-talk on the official Foxhole discord.