Game data

References

Retrieve valid game identifiers grouped by the type your feature expects.

Item, vehicle and structure labels come from FIR's Foxhole airborne-63 catalog. Identifiers observed in saves but absent from that catalog remain available with their identifier as a fallback label.

Available types

GET/v1/references/itemItems and item crates

GET/v1/references/vehicleVehicles

GET/v1/references/structureStructures

GET/v1/references/mapFoxhole map identifiers

GET/v1/references/cityCity and locality names

Items and crates

Foxhole uses the same code name for an item and its crate. Item references expose both items and itemCrates as source categories. The API performs no quantity conversion.

Each FIR-backed reference includes category, gameVersion, patchVersion, iconUrl and cratedIconUrl. Icon files follow FIR's exact {CodeName}.png and {CodeName}-crated.png convention.

FIR releases are discovered and checked every day at 07:00 UTC and at API startup. Keep v1 for the HTTP contract and select game data through /v1/game-data/{release}. Releases accept their full name, patch number, or lts; for example airborne-63, 63, and lts.

Examples

GET https://compagnon-api.foxwar.net/v1/references/map
GET https://compagnon-api.foxwar.net/v1/references/city
GET https://compagnon-api.foxwar.net/v1/references/item?q=MetalBeamMaterial
GET https://compagnon-api.foxwar.net/v1/game-data/releases
GET https://compagnon-api.foxwar.net/v1/game-data/lts/references/item?q=MetalBeam
GET https://compagnon-api.foxwar.net/v1/game-data/airborne-63/catalog/RifleW
GET https://compagnon-api.foxwar.net/v1/game-data/63/icons/RifleW-crated.png

The optional q parameter searches stable id values, visibleName, and aliases. The stable text id is used by every database relation. visibleName is the user-facing label and falls back to id when no custom value is stored. The deprecated codeName response property remains equal to id for client compatibility. City references expose every known normalized position as { mapId, x, y, mapMarkerType }.