Core resources

Stockpiles

Stockpiles are read-only API resources populated by signed companion uploads.

Versioned routes

GET/v1/stockpiles/mapsList accessible maps

GET/v1/stockpiles/maps/:mapIdRead one map collection

GET/v1/stockpiles/maps/:mapId/locations/:locationIdRead stockpiles near a location

GET/v1/stockpiles/search?q=basicSearch by partial name, stable ID, or alias

GET/v1/stockpiles/historyQuery quantity changes

Friendly search

q and items are equivalent. Values may be partial and comma-separated. Map, city, and structure filters also accept partial values. Results return itemDisplayName for UI labels, itemName as the stable identifier, and itemAliases for alternate names.

Public contents

Require stockpile.read and are restricted to stockpiles controlled by the authenticated player's faction.

Reserve contents

Require regiment.read and an exact access grant previously observed by the companion.

Snapshot consistency

Uploads are merged by map, structure code name, and coordinates. Unobserved public or reserve contents are preserved, observed zeroes are stored, older snapshots are ignored, and stock plus history commit in one transaction. Reads wait behind pending writes.