Skip to content

Resource AllianceResource

Jump to bottom
CrucifiedPain edited this page Jun 26, 2026 · 10 revisions

AllianceResource (client.alliance)

Endpoints: • alliance.getById • alliance.getByIds • alliance.getManyPaginated (cursor-paginated)

.collect_all()

Fetch all items across all pages concurrently using parallel time-slicing.

Signature

await client.alliance.collect_all(**kwargs: 'typing.Any') -> 'list[Alliance]'

Parameters

Name Type Default
kwargs Any Required

Return Models

Alliance

Field Type Required
_id string Optional
__v integer Optional
name string Optional
scheme string Optional
mapAccent string Optional
leader string Optional
memberCountries array[AllianceMemberCountry] Optional
currentDevelopment number | integer Optional
coreDevelopment number | integer Optional
averageDevelopment number | integer Optional
createdAt string Optional
updatedAt string Optional
rankings AllianceRankings Optional
avatarUrl string Optional

AllianceMemberCountry

Field Type Required
_id string Optional
__v integer Optional
country string Optional
coreDevelopment number | integer Optional
averageDevelopment number | integer Optional
suspended boolean Optional

AllianceRankingEntry

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

AllianceRankings

Field Type Required
_id string Optional
__v integer Optional
allianceInitialDevelopment AllianceRankingEntry Optional
allianceDevelopment AllianceRankingEntry Optional
allianceWeeklyDamages AllianceRankingEntry Optional
allianceDamages AllianceRankingEntry Optional
alliancePopulation AllianceRankingEntry Optional
allianceWeeklyDamagesPerCitizen AllianceRankingEntry Optional

.get()

Get a single alliance by ID.

Signature

await client.alliance.get(alliance_id: 'str') -> 'Alliance'

Parameters

Name Type Default
alliance_id str Required

Return Models

Alliance

Field Type Required
_id string Optional
__v integer Optional
name string Optional
scheme string Optional
mapAccent string Optional
leader string Optional
memberCountries array[AllianceMemberCountry] Optional
currentDevelopment number | integer Optional
coreDevelopment number | integer Optional
averageDevelopment number | integer Optional
createdAt string Optional
updatedAt string Optional
rankings AllianceRankings Optional
avatarUrl string Optional

AllianceMemberCountry

Field Type Required
_id string Optional
__v integer Optional
country string Optional
coreDevelopment number | integer Optional
averageDevelopment number | integer Optional
suspended boolean Optional

AllianceRankingEntry

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

AllianceRankings

Field Type Required
_id string Optional
__v integer Optional
allianceInitialDevelopment AllianceRankingEntry Optional
allianceDevelopment AllianceRankingEntry Optional
allianceWeeklyDamages AllianceRankingEntry Optional
allianceDamages AllianceRankingEntry Optional
alliancePopulation AllianceRankingEntry Optional
allianceWeeklyDamagesPerCitizen AllianceRankingEntry Optional

.get_many()

Get multiple alliances by their IDs.

Signature

await client.alliance.get_many(ids: 'list[str]') -> 'list[Alliance]'

Parameters

Name Type Default
ids list[str] Required

Return Models

Alliance

Field Type Required
_id string Optional
__v integer Optional
name string Optional
scheme string Optional
mapAccent string Optional
leader string Optional
memberCountries array[AllianceMemberCountry] Optional
currentDevelopment number | integer Optional
coreDevelopment number | integer Optional
averageDevelopment number | integer Optional
createdAt string Optional
updatedAt string Optional
rankings AllianceRankings Optional
avatarUrl string Optional

AllianceMemberCountry

Field Type Required
_id string Optional
__v integer Optional
country string Optional
coreDevelopment number | integer Optional
averageDevelopment number | integer Optional
suspended boolean Optional

AllianceRankingEntry

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

AllianceRankings

Field Type Required
_id string Optional
__v integer Optional
allianceInitialDevelopment AllianceRankingEntry Optional
allianceDevelopment AllianceRankingEntry Optional
allianceWeeklyDamages AllianceRankingEntry Optional
allianceDamages AllianceRankingEntry Optional
alliancePopulation AllianceRankingEntry Optional
allianceWeeklyDamagesPerCitizen AllianceRankingEntry Optional

.get_paginated()

Get alliances (cursor-paginated).

Signature

await client.alliance.get_paginated(*, limit: 'int' = 20, cursor: 'str | None' = None, auto_items: 'bool' = False, max_pages: 'int | float' = inf, cursor_end: 'str | None' = None) -> 'CursorPage[Alliance] | AsyncIterator[Alliance]'

Parameters

Name Type Default
limit int 20
cursor str None
auto_items bool False
max_pages int | float inf
cursor_end str None

Return Models

Alliance

Field Type Required
_id string Optional
__v integer Optional
name string Optional
scheme string Optional
mapAccent string Optional
leader string Optional
memberCountries array[AllianceMemberCountry] Optional
currentDevelopment number | integer Optional
coreDevelopment number | integer Optional
averageDevelopment number | integer Optional
createdAt string Optional
updatedAt string Optional
rankings AllianceRankings Optional
avatarUrl string Optional

AllianceMemberCountry

Field Type Required
_id string Optional
__v integer Optional
country string Optional
coreDevelopment number | integer Optional
averageDevelopment number | integer Optional
suspended boolean Optional

AllianceRankingEntry

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

AllianceRankings

Field Type Required
_id string Optional
__v integer Optional
allianceInitialDevelopment AllianceRankingEntry Optional
allianceDevelopment AllianceRankingEntry Optional
allianceWeeklyDamages AllianceRankingEntry Optional
allianceDamages AllianceRankingEntry Optional
alliancePopulation AllianceRankingEntry Optional
allianceWeeklyDamagesPerCitizen AllianceRankingEntry Optional

CursorPage[Alliance]

Field Type Required
_id string Optional
__v integer Optional
items array[Alliance] Required
nextCursor string Optional
hasMore boolean Optional

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

Warera API Client

Getting Started

Guides

Reference

Resources

Clone this wiki locally