Skip to content

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
_id string Optional
__v integer Optional
war string Optional
region string Optional
attacker_country_id string Optional
defender_country_id string Optional
attacker BattleSide Optional
defender BattleSide Optional
attackerScore number Optional
defenderScore number Optional
isActive boolean Optional
isSystemResistance boolean Optional
isBigBattle boolean Optional
winner_country string Optional
startTime string Optional
endTime string Optional
currentRound string | integer | object Optional
rounds array[string] Optional
roundsHistory array[any] Optional
roundsToWin integer Optional
totalRounds integer Optional
type string Optional
stats BattleStats Optional
createdAt string Optional
updatedAt string Optional

BattleSide

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

Field Type Required
_id string Optional
__v integer Optional
country string Optional
region string Optional
damages number Optional
hitCount integer Optional
wonRoundsCount integer Optional
countryOrders array[string] Optional
muOrders array[string] Optional
moneyPool number Optional
moneyPer1kDamages number Optional
bountyEffectiveAt string Optional

BattleStats

Field Type Required
_id string Optional
__v integer Optional
hitCount integer Optional

Region

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

RegionActiveUpgradeLevels

Field Type Required
_id string Optional
__v integer Optional
base integer Optional
bunker integer Optional
pacificationCenter integer Optional

RegionDates

Field Type Required
_id string Optional
__v integer Optional
lastOwnershipChangeAt string Optional

RegionDeposit

Field Type Required
_id string Optional
__v integer Optional
type string Optional
bonusPercent number Optional
startsAt string Optional
endsAt string Optional

RegionStats

Field Type Required
_id string Optional
__v integer Optional
investedMoney number Optional

RegionUpgrade

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

Field Type Required
_id string Optional
__v integer Optional
level integer Optional
status string Optional
statusChangedAt string Optional
constructionPoints number Optional
investedMoney number Optional
isUnderConstruction boolean Optional
constructionStartedAt string Optional
constructionEndedAt string Optional
lastConstructions array[RegionUpgradeConstruction] Optional

RegionUpgradeConstruction

One contribution entry in an upgrade's construction history.

Field Type Required
_id string Optional
__v integer Optional
construction number Optional
constructionAt string Optional
user string Optional

RegionUpgradesV2

Field Type Required
_id string Optional
__v integer Optional
upgrades object Optional
activeConstructionCount integer Optional

.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
_id string Optional
__v integer Optional
war string Optional
region string Optional
attacker_country_id string Optional
defender_country_id string Optional
attacker BattleSide Optional
defender BattleSide Optional
attackerScore number Optional
defenderScore number Optional
isActive boolean Optional
isSystemResistance boolean Optional
isBigBattle boolean Optional
winner_country string Optional
startTime string Optional
endTime string Optional
currentRound string | integer | object Optional
rounds array[string] Optional
roundsHistory array[any] Optional
roundsToWin integer Optional
totalRounds integer Optional
type string Optional
stats BattleStats Optional
createdAt string Optional
updatedAt string Optional

BattleSide

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

Field Type Required
_id string Optional
__v integer Optional
country string Optional
region string Optional
damages number Optional
hitCount integer Optional
wonRoundsCount integer Optional
countryOrders array[string] Optional
muOrders array[string] Optional
moneyPool number Optional
moneyPer1kDamages number Optional
bountyEffectiveAt string Optional

BattleStats

Field Type Required
_id string Optional
__v integer Optional
hitCount integer Optional

Region

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

RegionActiveUpgradeLevels

Field Type Required
_id string Optional
__v integer Optional
base integer Optional
bunker integer Optional
pacificationCenter integer Optional

RegionDates

Field Type Required
_id string Optional
__v integer Optional
lastOwnershipChangeAt string Optional

RegionDeposit

Field Type Required
_id string Optional
__v integer Optional
type string Optional
bonusPercent number Optional
startsAt string Optional
endsAt string Optional

RegionStats

Field Type Required
_id string Optional
__v integer Optional
investedMoney number Optional

RegionUpgrade

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

Field Type Required
_id string Optional
__v integer Optional
level integer Optional
status string Optional
statusChangedAt string Optional
constructionPoints number Optional
investedMoney number Optional
isUnderConstruction boolean Optional
constructionStartedAt string Optional
constructionEndedAt string Optional
lastConstructions array[RegionUpgradeConstruction] Optional

RegionUpgradeConstruction

One contribution entry in an upgrade's construction history.

Field Type Required
_id string Optional
__v integer Optional
construction number Optional
constructionAt string Optional
user string Optional

RegionUpgradesV2

Field Type Required
_id string Optional
__v integer Optional
upgrades object Optional
activeConstructionCount integer Optional

.get_all_list()

Get all regions as a list.

Signature

await client.region.get_all_list() -> 'list[Region]'

Return Models

Battle

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

BattleSide

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

Field Type Required
_id string Optional
__v integer Optional
country string Optional
region string Optional
damages number Optional
hitCount integer Optional
wonRoundsCount integer Optional
countryOrders array[string] Optional
muOrders array[string] Optional
moneyPool number Optional
moneyPer1kDamages number Optional
bountyEffectiveAt string Optional

BattleStats

Field Type Required
_id string Optional
__v integer Optional
hitCount integer Optional

Region

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

RegionActiveUpgradeLevels

Field Type Required
_id string Optional
__v integer Optional
base integer Optional
bunker integer Optional
pacificationCenter integer Optional

RegionDates

Field Type Required
_id string Optional
__v integer Optional
lastOwnershipChangeAt string Optional

RegionDeposit

Field Type Required
_id string Optional
__v integer Optional
type string Optional
bonusPercent number Optional
startsAt string Optional
endsAt string Optional

RegionStats

Field Type Required
_id string Optional
__v integer Optional
investedMoney number Optional

RegionUpgrade

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

Field Type Required
_id string Optional
__v integer Optional
level integer Optional
status string Optional
statusChangedAt string Optional
constructionPoints number Optional
investedMoney number Optional
isUnderConstruction boolean Optional
constructionStartedAt string Optional
constructionEndedAt string Optional
lastConstructions array[RegionUpgradeConstruction] Optional

RegionUpgradeConstruction

One contribution entry in an upgrade's construction history.

Field Type Required
_id string Optional
__v integer Optional
construction number Optional
constructionAt string Optional
user string Optional

RegionUpgradesV2

Field Type Required
_id string Optional
__v integer Optional
upgrades object Optional
activeConstructionCount integer Optional

.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
_id string Optional
__v integer Optional
war string Optional
region string Optional
attacker_country_id string Optional
defender_country_id string Optional
attacker BattleSide Optional
defender BattleSide Optional
attackerScore number Optional
defenderScore number Optional
isActive boolean Optional
isSystemResistance boolean Optional
isBigBattle boolean Optional
winner_country string Optional
startTime string Optional
endTime string Optional
currentRound string | integer | object Optional
rounds array[string] Optional
roundsHistory array[any] Optional
roundsToWin integer Optional
totalRounds integer Optional
type string Optional
stats BattleStats Optional
createdAt string Optional
updatedAt string Optional

BattleSide

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

Field Type Required
_id string Optional
__v integer Optional
country string Optional
region string Optional
damages number Optional
hitCount integer Optional
wonRoundsCount integer Optional
countryOrders array[string] Optional
muOrders array[string] Optional
moneyPool number Optional
moneyPer1kDamages number Optional
bountyEffectiveAt string Optional

BattleStats

Field Type Required
_id string Optional
__v integer Optional
hitCount integer Optional

Region

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

RegionActiveUpgradeLevels

Field Type Required
_id string Optional
__v integer Optional
base integer Optional
bunker integer Optional
pacificationCenter integer Optional

RegionDates

Field Type Required
_id string Optional
__v integer Optional
lastOwnershipChangeAt string Optional

RegionDeposit

Field Type Required
_id string Optional
__v integer Optional
type string Optional
bonusPercent number Optional
startsAt string Optional
endsAt string Optional

RegionStats

Field Type Required
_id string Optional
__v integer Optional
investedMoney number Optional

RegionUpgrade

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

Field Type Required
_id string Optional
__v integer Optional
level integer Optional
status string Optional
statusChangedAt string Optional
constructionPoints number Optional
investedMoney number Optional
isUnderConstruction boolean Optional
constructionStartedAt string Optional
constructionEndedAt string Optional
lastConstructions array[RegionUpgradeConstruction] Optional

RegionUpgradeConstruction

One contribution entry in an upgrade's construction history.

Field Type Required
_id string Optional
__v integer Optional
construction number Optional
constructionAt string Optional
user string Optional

RegionUpgradesV2

Field Type Required
_id string Optional
__v integer Optional
upgrades object Optional
activeConstructionCount integer Optional

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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