Skip to content

CountryResource (client.country)

Endpoints: • country.getCountryById • country.getAllCountries

.find_by_name()

Client-side helper: return the country matching name (case-insensitive).

Returns None if no country with that name exists.

Signature

await client.country.find_by_name(name: 'str') -> 'Country | None'

Parameters

Name Type Default
name str Required

Return Models

Country

Field Type Required
_id string Optional
__v integer Optional
name string Optional
code string Optional
money number Optional
scheme string Optional
mapAccent string Optional
discordUrl string Optional
specializedItem string Optional
pinnedArticle string Optional
currentBattleOrder string Optional
rulingParty string Optional
allianceId string Optional
enemy string Optional
allies array[string] Optional
warsWith array[string] Optional
defensivePacts array[string] Optional
orgs array[string] Optional
nonAggressionUntil object Optional
development number Optional
currentDevelopment number Optional
averageDevelopment number Optional
coreDevelopment number Optional
currentPopulation integer Optional
taxes CountryTaxes Optional
unrest CountryUnrest Optional
strategicResources CountryStrategicResources Optional
rankings CountryRankings Optional
createdAt string Optional
updatedAt string Optional

CountryRankings

Field Type Required
_id string Optional
__v integer Optional
countryRegionDiff RankingDetail Optional
countryDamages RankingDetail Optional
weeklyCountryDamages RankingDetail Optional
weeklyCountryDamagesPerCitizen RankingDetail Optional
countryDevelopment RankingDetail Optional
countryActivePopulation RankingDetail Optional
countryWealth RankingDetail Optional
countryBounty RankingDetail Optional
countryProductionBonus RankingDetail Optional

CountryStrategicBonuses

Field Type Required
_id string Optional
__v integer Optional
productionPercent number Optional
developmentPercent number Optional

CountryStrategicResourceMap

Region IDs holding each strategic resource.

Field Type Required
_id string Optional
__v integer Optional
coal array[string] Optional
diamonds array[string] Optional
gold array[string] Optional
lithium array[string] Optional
rareEarths array[string] Optional
uranium array[string] Optional

CountryStrategicResources

Field Type Required
_id string Optional
__v integer Optional
resources CountryStrategicResourceMap Optional
bonuses CountryStrategicBonuses Optional

CountryTaxes

Field Type Required
_id string Optional
__v integer Optional
income number Optional
market number Optional
selfWork number Optional

CountryUnrest

Field Type Required
_id string Optional
__v integer Optional
bar number Optional
barMax number Optional
lastContributionAt string Optional

RankingDetail

Field Type Required
_id string Optional
__v integer Optional
value number Optional
rank integer Optional
tier string Optional
country string Optional

.get()

Get a single country by ID.

Signature

await client.country.get(country_id: 'str') -> 'Country'

Parameters

Name Type Default
country_id str Required

Return Models

Country

Field Type Required
_id string Optional
__v integer Optional
name string Optional
code string Optional
money number Optional
scheme string Optional
mapAccent string Optional
discordUrl string Optional
specializedItem string Optional
pinnedArticle string Optional
currentBattleOrder string Optional
rulingParty string Optional
allianceId string Optional
enemy string Optional
allies array[string] Optional
warsWith array[string] Optional
defensivePacts array[string] Optional
orgs array[string] Optional
nonAggressionUntil object Optional
development number Optional
currentDevelopment number Optional
averageDevelopment number Optional
coreDevelopment number Optional
currentPopulation integer Optional
taxes CountryTaxes Optional
unrest CountryUnrest Optional
strategicResources CountryStrategicResources Optional
rankings CountryRankings Optional
createdAt string Optional
updatedAt string Optional

CountryRankings

Field Type Required
_id string Optional
__v integer Optional
countryRegionDiff RankingDetail Optional
countryDamages RankingDetail Optional
weeklyCountryDamages RankingDetail Optional
weeklyCountryDamagesPerCitizen RankingDetail Optional
countryDevelopment RankingDetail Optional
countryActivePopulation RankingDetail Optional
countryWealth RankingDetail Optional
countryBounty RankingDetail Optional
countryProductionBonus RankingDetail Optional

CountryStrategicBonuses

Field Type Required
_id string Optional
__v integer Optional
productionPercent number Optional
developmentPercent number Optional

CountryStrategicResourceMap

Region IDs holding each strategic resource.

Field Type Required
_id string Optional
__v integer Optional
coal array[string] Optional
diamonds array[string] Optional
gold array[string] Optional
lithium array[string] Optional
rareEarths array[string] Optional
uranium array[string] Optional

CountryStrategicResources

Field Type Required
_id string Optional
__v integer Optional
resources CountryStrategicResourceMap Optional
bonuses CountryStrategicBonuses Optional

CountryTaxes

Field Type Required
_id string Optional
__v integer Optional
income number Optional
market number Optional
selfWork number Optional

CountryUnrest

Field Type Required
_id string Optional
__v integer Optional
bar number Optional
barMax number Optional
lastContributionAt string Optional

RankingDetail

Field Type Required
_id string Optional
__v integer Optional
value number Optional
rank integer Optional
tier string Optional
country string Optional

.get_all()

Get all countries. Returns a dict keyed by country ID for O(1) lookups.

Signature

await client.country.get_all() -> 'dict[str, Country]'

Return Models

Country

Field Type Required
_id string Optional
__v integer Optional
name string Optional
code string Optional
money number Optional
scheme string Optional
mapAccent string Optional
discordUrl string Optional
specializedItem string Optional
pinnedArticle string Optional
currentBattleOrder string Optional
rulingParty string Optional
allianceId string Optional
enemy string Optional
allies array[string] Optional
warsWith array[string] Optional
defensivePacts array[string] Optional
orgs array[string] Optional
nonAggressionUntil object Optional
development number Optional
currentDevelopment number Optional
averageDevelopment number Optional
coreDevelopment number Optional
currentPopulation integer Optional
taxes CountryTaxes Optional
unrest CountryUnrest Optional
strategicResources CountryStrategicResources Optional
rankings CountryRankings Optional
createdAt string Optional
updatedAt string Optional

CountryRankings

Field Type Required
_id string Optional
__v integer Optional
countryRegionDiff RankingDetail Optional
countryDamages RankingDetail Optional
weeklyCountryDamages RankingDetail Optional
weeklyCountryDamagesPerCitizen RankingDetail Optional
countryDevelopment RankingDetail Optional
countryActivePopulation RankingDetail Optional
countryWealth RankingDetail Optional
countryBounty RankingDetail Optional
countryProductionBonus RankingDetail Optional

CountryStrategicBonuses

Field Type Required
_id string Optional
__v integer Optional
productionPercent number Optional
developmentPercent number Optional

CountryStrategicResourceMap

Region IDs holding each strategic resource.

Field Type Required
_id string Optional
__v integer Optional
coal array[string] Optional
diamonds array[string] Optional
gold array[string] Optional
lithium array[string] Optional
rareEarths array[string] Optional
uranium array[string] Optional

CountryStrategicResources

Field Type Required
_id string Optional
__v integer Optional
resources CountryStrategicResourceMap Optional
bonuses CountryStrategicBonuses Optional

CountryTaxes

Field Type Required
_id string Optional
__v integer Optional
income number Optional
market number Optional
selfWork number Optional

CountryUnrest

Field Type Required
_id string Optional
__v integer Optional
bar number Optional
barMax number Optional
lastContributionAt string Optional

RankingDetail

Field Type Required
_id string Optional
__v integer Optional
value number Optional
rank integer Optional
tier string Optional
country string Optional

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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