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 Description
_id `string null` No
__v `integer null` No
name `string null` No
scheme `string null` No
mapAccent `string null` No
leader `string null` No
memberCountries `array[AllianceMemberCountry] null` No
currentDevelopment `number integer null`
coreDevelopment `number integer null`
averageDevelopment `number integer null`
createdAt `string null` No
updatedAt `string null` No
rankings `AllianceRankings null` No
avatarUrl `string null` No

AllianceMemberCountry

Field Type Required Description
_id `string null` No
__v `integer null` No
country `string null` No
coreDevelopment `number integer null`
averageDevelopment `number integer null`
suspended `boolean null` No

AllianceRankingEntry

Field Type Required Description
_id `string null` No
__v `integer null` No
value `number integer null`
rank `integer null` No
tier `string null` No

AllianceRankings

Field Type Required Description
_id `string null` No
__v `integer null` No
allianceInitialDevelopment `AllianceRankingEntry null` No
allianceDevelopment `AllianceRankingEntry null` No
allianceWeeklyDamages `AllianceRankingEntry null` No
allianceDamages `AllianceRankingEntry null` No
alliancePopulation `AllianceRankingEntry null` No
allianceWeeklyDamagesPerCitizen `AllianceRankingEntry null` No

.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 Description
_id `string null` No
__v `integer null` No
name `string null` No
scheme `string null` No
mapAccent `string null` No
leader `string null` No
memberCountries `array[AllianceMemberCountry] null` No
currentDevelopment `number integer null`
coreDevelopment `number integer null`
averageDevelopment `number integer null`
createdAt `string null` No
updatedAt `string null` No
rankings `AllianceRankings null` No
avatarUrl `string null` No

AllianceMemberCountry

Field Type Required Description
_id `string null` No
__v `integer null` No
country `string null` No
coreDevelopment `number integer null`
averageDevelopment `number integer null`
suspended `boolean null` No

AllianceRankingEntry

Field Type Required Description
_id `string null` No
__v `integer null` No
value `number integer null`
rank `integer null` No
tier `string null` No

AllianceRankings

Field Type Required Description
_id `string null` No
__v `integer null` No
allianceInitialDevelopment `AllianceRankingEntry null` No
allianceDevelopment `AllianceRankingEntry null` No
allianceWeeklyDamages `AllianceRankingEntry null` No
allianceDamages `AllianceRankingEntry null` No
alliancePopulation `AllianceRankingEntry null` No
allianceWeeklyDamagesPerCitizen `AllianceRankingEntry null` No

.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 Description
_id `string null` No
__v `integer null` No
name `string null` No
scheme `string null` No
mapAccent `string null` No
leader `string null` No
memberCountries `array[AllianceMemberCountry] null` No
currentDevelopment `number integer null`
coreDevelopment `number integer null`
averageDevelopment `number integer null`
createdAt `string null` No
updatedAt `string null` No
rankings `AllianceRankings null` No
avatarUrl `string null` No

AllianceMemberCountry

Field Type Required Description
_id `string null` No
__v `integer null` No
country `string null` No
coreDevelopment `number integer null`
averageDevelopment `number integer null`
suspended `boolean null` No

AllianceRankingEntry

Field Type Required Description
_id `string null` No
__v `integer null` No
value `number integer null`
rank `integer null` No
tier `string null` No

AllianceRankings

Field Type Required Description
_id `string null` No
__v `integer null` No
allianceInitialDevelopment `AllianceRankingEntry null` No
allianceDevelopment `AllianceRankingEntry null` No
allianceWeeklyDamages `AllianceRankingEntry null` No
allianceDamages `AllianceRankingEntry null` No
alliancePopulation `AllianceRankingEntry null` No
allianceWeeklyDamagesPerCitizen `AllianceRankingEntry null` No

.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`
cursor_end `str None`

Return Models

Alliance

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

AllianceMemberCountry

Field Type Required Description
_id `string null` No
__v `integer null` No
country `string null` No
coreDevelopment `number integer null`
averageDevelopment `number integer null`
suspended `boolean null` No

AllianceRankingEntry

Field Type Required Description
_id `string null` No
__v `integer null` No
value `number integer null`
rank `integer null` No
tier `string null` No

AllianceRankings

Field Type Required Description
_id `string null` No
__v `integer null` No
allianceInitialDevelopment `AllianceRankingEntry null` No
allianceDevelopment `AllianceRankingEntry null` No
allianceWeeklyDamages `AllianceRankingEntry null` No
allianceDamages `AllianceRankingEntry null` No
alliancePopulation `AllianceRankingEntry null` No
allianceWeeklyDamagesPerCitizen `AllianceRankingEntry null` No

CursorPage[Alliance]

Field Type Required Description
_id `string null` No
__v `integer null` No
items array[Alliance] Yes
nextCursor `string null` No
hasMore boolean No

.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