Resource RegionResource

RegionResource (client.region)

Endpoints: • region.getById • region.getRegionsObject

.get()

Get a single region by ID.

Signature

await client.region.get(region_id: 'str') -> 'Region'

Parameters

Name	Type	Default
region_id	str	*Required*

Return Models

Battle

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
war	string \| null	❌
region	string \| null	❌
attacker_country_id	string \| null	❌
defender_country_id	string \| null	❌
attacker	BattleSide \| null	❌
defender	BattleSide \| null	❌
attackerScore	number \| null	❌
defenderScore	number \| null	❌
isActive	boolean \| null	❌
isSystemResistance	boolean \| null	❌
isBigBattle	boolean \| null	❌
winner_country	string \| null	❌
startTime	string \| null	❌
endTime	string \| null	❌
currentRound	string \| integer \| object \| null	❌
rounds	array[string] \| null	❌
roundsHistory	array[any] \| null	❌
roundsToWin	integer \| null	❌
totalRounds	integer \| null	❌
type	string \| null	❌
stats	BattleStats \| null	❌
createdAt	string \| null	❌
updatedAt	string \| null	❌

BattleSide

Per-side summary (attacker/defender) of a battle.

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
country	string \| null	❌
region	string \| null	❌
damages	number \| null	❌
hitCount	integer \| null	❌
wonRoundsCount	integer \| null	❌
countryOrders	array[string] \| null	❌
muOrders	array[string] \| null	❌
moneyPool	number \| null	❌
moneyPer1kDamages	number \| null	❌
bountyEffectiveAt	string \| null	❌

BattleStats

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
hitCount	integer \| null	❌

Region

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
name	string \| null	❌
code	string \| null	❌
mainCity	string \| null	❌
country	string \| null	❌
countryCode	string \| null	❌
initialCountry	string \| null	❌
isCapital	boolean \| null	❌
isLinkedToCapital	boolean \| null	❌
hasCoast	boolean \| null	❌
biome	string \| null	❌
climate	string \| null	❌
position	array[number] \| null	❌
neighbors	array[string] \| null	❌
development	number \| null	❌
baseDevelopment	number \| null	❌
currentPopulation	integer \| null	❌
resistance	number \| null	❌
resistanceMax	number \| null	❌
strategicResource	string \| null	❌
deposit	RegionDeposit \| null	❌
stats	RegionStats \| null	❌
dates	RegionDates \| null	❌
activeUpgradeLevels	RegionActiveUpgradeLevels \| null	❌
upgradesV2	RegionUpgradesV2 \| null	❌
activeBattle	Battle \| null	❌
lastBattleEndedAt	string \| null	❌
lastResistanceContributionAt	string \| null	❌
lastRevoltEndedAt	string \| null	❌

RegionActiveUpgradeLevels

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
base	integer \| null	❌
bunker	integer \| null	❌
pacificationCenter	integer \| null	❌

RegionDates

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
lastOwnershipChangeAt	string \| null	❌

RegionDeposit

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
type	string \| null	❌
bonusPercent	number \| null	❌
startsAt	string \| null	❌
endsAt	string \| null	❌

RegionStats

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
investedMoney	number \| null	❌

RegionUpgrade

State of a single region upgrade (base, bunker, ...).

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
level	integer \| null	❌
status	string \| null	❌
statusChangedAt	string \| null	❌
constructionPoints	number \| null	❌
investedMoney	number \| null	❌
isUnderConstruction	boolean \| null	❌
constructionStartedAt	string \| null	❌
constructionEndedAt	string \| null	❌
lastConstructions	array[RegionUpgradeConstruction] \| null	❌

RegionUpgradeConstruction

One contribution entry in an upgrade's construction history.

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
construction	number \| null	❌
constructionAt	string \| null	❌
user	string \| null	❌

RegionUpgradesV2

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
upgrades	object \| null	❌
activeConstructionCount	integer \| null	❌

---

.get_all()

Get all regions as a dict keyed by region ID.

Signature

await client.region.get_all() -> 'dict[str, Region]'

Return Models

Battle

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
war	string \| null	❌
region	string \| null	❌
attacker_country_id	string \| null	❌
defender_country_id	string \| null	❌
attacker	BattleSide \| null	❌
defender	BattleSide \| null	❌
attackerScore	number \| null	❌
defenderScore	number \| null	❌
isActive	boolean \| null	❌
isSystemResistance	boolean \| null	❌
isBigBattle	boolean \| null	❌
winner_country	string \| null	❌
startTime	string \| null	❌
endTime	string \| null	❌
currentRound	string \| integer \| object \| null	❌
rounds	array[string] \| null	❌
roundsHistory	array[any] \| null	❌
roundsToWin	integer \| null	❌
totalRounds	integer \| null	❌
type	string \| null	❌
stats	BattleStats \| null	❌
createdAt	string \| null	❌
updatedAt	string \| null	❌

BattleSide

Per-side summary (attacker/defender) of a battle.

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
country	string \| null	❌
region	string \| null	❌
damages	number \| null	❌
hitCount	integer \| null	❌
wonRoundsCount	integer \| null	❌
countryOrders	array[string] \| null	❌
muOrders	array[string] \| null	❌
moneyPool	number \| null	❌
moneyPer1kDamages	number \| null	❌
bountyEffectiveAt	string \| null	❌

BattleStats

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
hitCount	integer \| null	❌

Region

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
name	string \| null	❌
code	string \| null	❌
mainCity	string \| null	❌
country	string \| null	❌
countryCode	string \| null	❌
initialCountry	string \| null	❌
isCapital	boolean \| null	❌
isLinkedToCapital	boolean \| null	❌
hasCoast	boolean \| null	❌
biome	string \| null	❌
climate	string \| null	❌
position	array[number] \| null	❌
neighbors	array[string] \| null	❌
development	number \| null	❌
baseDevelopment	number \| null	❌
currentPopulation	integer \| null	❌
resistance	number \| null	❌
resistanceMax	number \| null	❌
strategicResource	string \| null	❌
deposit	RegionDeposit \| null	❌
stats	RegionStats \| null	❌
dates	RegionDates \| null	❌
activeUpgradeLevels	RegionActiveUpgradeLevels \| null	❌
upgradesV2	RegionUpgradesV2 \| null	❌
activeBattle	Battle \| null	❌
lastBattleEndedAt	string \| null	❌
lastResistanceContributionAt	string \| null	❌
lastRevoltEndedAt	string \| null	❌

RegionActiveUpgradeLevels

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
base	integer \| null	❌
bunker	integer \| null	❌
pacificationCenter	integer \| null	❌

RegionDates

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
lastOwnershipChangeAt	string \| null	❌

RegionDeposit

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
type	string \| null	❌
bonusPercent	number \| null	❌
startsAt	string \| null	❌
endsAt	string \| null	❌

RegionStats

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
investedMoney	number \| null	❌

RegionUpgrade

State of a single region upgrade (base, bunker, ...).

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
level	integer \| null	❌
status	string \| null	❌
statusChangedAt	string \| null	❌
constructionPoints	number \| null	❌
investedMoney	number \| null	❌
isUnderConstruction	boolean \| null	❌
constructionStartedAt	string \| null	❌
constructionEndedAt	string \| null	❌
lastConstructions	array[RegionUpgradeConstruction] \| null	❌

RegionUpgradeConstruction

One contribution entry in an upgrade's construction history.

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
construction	number \| null	❌
constructionAt	string \| null	❌
user	string \| null	❌

RegionUpgradesV2

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
upgrades	object \| null	❌
activeConstructionCount	integer \| null	❌

---

.get_many()

Fetch multiple regions by ID concurrently using the auto-batcher.

Signature

await client.region.get_many(region_ids: 'list[str]') -> 'list[Region | None]'

Parameters

Name	Type	Default
region_ids	list[str]	*Required*

Return Models

Battle

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
war	string \| null	❌
region	string \| null	❌
attacker_country_id	string \| null	❌
defender_country_id	string \| null	❌
attacker	BattleSide \| null	❌
defender	BattleSide \| null	❌
attackerScore	number \| null	❌
defenderScore	number \| null	❌
isActive	boolean \| null	❌
isSystemResistance	boolean \| null	❌
isBigBattle	boolean \| null	❌
winner_country	string \| null	❌
startTime	string \| null	❌
endTime	string \| null	❌
currentRound	string \| integer \| object \| null	❌
rounds	array[string] \| null	❌
roundsHistory	array[any] \| null	❌
roundsToWin	integer \| null	❌
totalRounds	integer \| null	❌
type	string \| null	❌
stats	BattleStats \| null	❌
createdAt	string \| null	❌
updatedAt	string \| null	❌

BattleSide

Per-side summary (attacker/defender) of a battle.

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
country	string \| null	❌
region	string \| null	❌
damages	number \| null	❌
hitCount	integer \| null	❌
wonRoundsCount	integer \| null	❌
countryOrders	array[string] \| null	❌
muOrders	array[string] \| null	❌
moneyPool	number \| null	❌
moneyPer1kDamages	number \| null	❌
bountyEffectiveAt	string \| null	❌

BattleStats

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
hitCount	integer \| null	❌

Region

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
name	string \| null	❌
code	string \| null	❌
mainCity	string \| null	❌
country	string \| null	❌
countryCode	string \| null	❌
initialCountry	string \| null	❌
isCapital	boolean \| null	❌
isLinkedToCapital	boolean \| null	❌
hasCoast	boolean \| null	❌
biome	string \| null	❌
climate	string \| null	❌
position	array[number] \| null	❌
neighbors	array[string] \| null	❌
development	number \| null	❌
baseDevelopment	number \| null	❌
currentPopulation	integer \| null	❌
resistance	number \| null	❌
resistanceMax	number \| null	❌
strategicResource	string \| null	❌
deposit	RegionDeposit \| null	❌
stats	RegionStats \| null	❌
dates	RegionDates \| null	❌
activeUpgradeLevels	RegionActiveUpgradeLevels \| null	❌
upgradesV2	RegionUpgradesV2 \| null	❌
activeBattle	Battle \| null	❌
lastBattleEndedAt	string \| null	❌
lastResistanceContributionAt	string \| null	❌
lastRevoltEndedAt	string \| null	❌

RegionActiveUpgradeLevels

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
base	integer \| null	❌
bunker	integer \| null	❌
pacificationCenter	integer \| null	❌

RegionDates

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
lastOwnershipChangeAt	string \| null	❌

RegionDeposit

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
type	string \| null	❌
bonusPercent	number \| null	❌
startsAt	string \| null	❌
endsAt	string \| null	❌

RegionStats

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
investedMoney	number \| null	❌

RegionUpgrade

State of a single region upgrade (base, bunker, ...).

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
level	integer \| null	❌
status	string \| null	❌
statusChangedAt	string \| null	❌
constructionPoints	number \| null	❌
investedMoney	number \| null	❌
isUnderConstruction	boolean \| null	❌
constructionStartedAt	string \| null	❌
constructionEndedAt	string \| null	❌
lastConstructions	array[RegionUpgradeConstruction] \| null	❌

RegionUpgradeConstruction

One contribution entry in an upgrade's construction history.

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
construction	number \| null	❌
constructionAt	string \| null	❌
user	string \| null	❌

RegionUpgradesV2

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
upgrades	object \| null	❌
activeConstructionCount	integer \| null	❌

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

await client.region.invalidate_cache() -> 'None'

---