Resource MUResource

MUResource (client.mu)

Endpoints: • mu.getById • mu.getManyPaginated (cursor-paginated)

.collect_all()

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

Signature

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

Parameters

Name	Type	Default
kwargs	Any	*Required*

Return Models

MilitaryUnit

Field	Type	Required
_id	string	Optional
__v	integer	Optional
name	string	Optional
countryId	string	Optional
ownerId	string	Optional
members	array[string]	Optional
damage	number	Optional
terrain	number	Optional
wealth	number	Optional
image	string	Optional
description	string	Optional
isRecruiting	boolean	Optional
activeUpgradeLevels	MuActiveUpgradeLevels	Optional
avatarUrl	string	Optional
rankings	MuRankings	Optional
region	string	Optional
roles	MuRoles	Optional
user	string	Optional
leveling	MuLeveling	Optional
investedMoneyByUsers	object	Optional
mercenaryReputation	number	Optional
lastReputationBuyAt	string	Optional
createdAt	string	Optional
updatedAt	string	Optional

MuActiveUpgradeLevels

Field	Type	Required
_id	string	Optional
__v	integer	Optional
headquarters	integer	Optional
dormitories	integer	Optional

MuLeveling

Field	Type	Required
_id	string	Optional
__v	integer	Optional
level	integer	Optional
monthlyDamages	number	Optional

MuRankings

Field	Type	Required
_id	string	Optional
__v	integer	Optional
muWeeklyDamages	RankingDetail	Optional
muDamages	RankingDetail	Optional
muTerrain	RankingDetail	Optional
muWealth	RankingDetail	Optional
muBounty	RankingDetail	Optional
muReputation	RankingDetail	Optional

MuRoles

Field	Type	Required
_id	string	Optional
__v	integer	Optional
commanders	array[string]	Optional
managers	array[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 military unit by ID.

Signature

await client.mu.get(mu_id: 'str') -> 'MilitaryUnit'

Parameters

Name	Type	Default
mu_id	str	*Required*

Return Models

MilitaryUnit

Field	Type	Required
_id	string	Optional
__v	integer	Optional
name	string	Optional
countryId	string	Optional
ownerId	string	Optional
members	array[string]	Optional
damage	number	Optional
terrain	number	Optional
wealth	number	Optional
image	string	Optional
description	string	Optional
isRecruiting	boolean	Optional
activeUpgradeLevels	MuActiveUpgradeLevels	Optional
avatarUrl	string	Optional
rankings	MuRankings	Optional
region	string	Optional
roles	MuRoles	Optional
user	string	Optional
leveling	MuLeveling	Optional
investedMoneyByUsers	object	Optional
mercenaryReputation	number	Optional
lastReputationBuyAt	string	Optional
createdAt	string	Optional
updatedAt	string	Optional

MuActiveUpgradeLevels

Field	Type	Required
_id	string	Optional
__v	integer	Optional
headquarters	integer	Optional
dormitories	integer	Optional

MuLeveling

Field	Type	Required
_id	string	Optional
__v	integer	Optional
level	integer	Optional
monthlyDamages	number	Optional

MuRankings

Field	Type	Required
_id	string	Optional
__v	integer	Optional
muWeeklyDamages	RankingDetail	Optional
muDamages	RankingDetail	Optional
muTerrain	RankingDetail	Optional
muWealth	RankingDetail	Optional
muBounty	RankingDetail	Optional
muReputation	RankingDetail	Optional

MuRoles

Field	Type	Required
_id	string	Optional
__v	integer	Optional
commanders	array[string]	Optional
managers	array[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_many()

Fetch multiple military units by ID concurrently using the auto-batcher.

Signature

await client.mu.get_many(mu_ids: 'list[str]') -> 'list[MilitaryUnit | None]'

Parameters

Name	Type	Default
mu_ids	list[str]	*Required*

Return Models

MilitaryUnit

Field	Type	Required
_id	string	Optional
__v	integer	Optional
name	string	Optional
countryId	string	Optional
ownerId	string	Optional
members	array[string]	Optional
damage	number	Optional
terrain	number	Optional
wealth	number	Optional
image	string	Optional
description	string	Optional
isRecruiting	boolean	Optional
activeUpgradeLevels	MuActiveUpgradeLevels	Optional
avatarUrl	string	Optional
rankings	MuRankings	Optional
region	string	Optional
roles	MuRoles	Optional
user	string	Optional
leveling	MuLeveling	Optional
investedMoneyByUsers	object	Optional
mercenaryReputation	number	Optional
lastReputationBuyAt	string	Optional
createdAt	string	Optional
updatedAt	string	Optional

MuActiveUpgradeLevels

Field	Type	Required
_id	string	Optional
__v	integer	Optional
headquarters	integer	Optional
dormitories	integer	Optional

MuLeveling

Field	Type	Required
_id	string	Optional
__v	integer	Optional
level	integer	Optional
monthlyDamages	number	Optional

MuRankings

Field	Type	Required
_id	string	Optional
__v	integer	Optional
muWeeklyDamages	RankingDetail	Optional
muDamages	RankingDetail	Optional
muTerrain	RankingDetail	Optional
muWealth	RankingDetail	Optional
muBounty	RankingDetail	Optional
muReputation	RankingDetail	Optional

MuRoles

Field	Type	Required
_id	string	Optional
__v	integer	Optional
commanders	array[string]	Optional
managers	array[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_paginated()

Get military units (cursor-paginated).

Args: member_id: Filter: MUs that this user is a member of. user_id: Filter: MUs owned/created by this user. search: Text search across MU names.

Signature

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

Parameters

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

Return Models

CursorPage[MilitaryUnit]

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

MilitaryUnit

Field	Type	Required
_id	string	Optional
__v	integer	Optional
name	string	Optional
countryId	string	Optional
ownerId	string	Optional
members	array[string]	Optional
damage	number	Optional
terrain	number	Optional
wealth	number	Optional
image	string	Optional
description	string	Optional
isRecruiting	boolean	Optional
activeUpgradeLevels	MuActiveUpgradeLevels	Optional
avatarUrl	string	Optional
rankings	MuRankings	Optional
region	string	Optional
roles	MuRoles	Optional
user	string	Optional
leveling	MuLeveling	Optional
investedMoneyByUsers	object	Optional
mercenaryReputation	number	Optional
lastReputationBuyAt	string	Optional
createdAt	string	Optional
updatedAt	string	Optional

MuActiveUpgradeLevels

Field	Type	Required
_id	string	Optional
__v	integer	Optional
headquarters	integer	Optional
dormitories	integer	Optional

MuLeveling

Field	Type	Required
_id	string	Optional
__v	integer	Optional
level	integer	Optional
monthlyDamages	number	Optional

MuRankings

Field	Type	Required
_id	string	Optional
__v	integer	Optional
muWeeklyDamages	RankingDetail	Optional
muDamages	RankingDetail	Optional
muTerrain	RankingDetail	Optional
muWealth	RankingDetail	Optional
muBounty	RankingDetail	Optional
muReputation	RankingDetail	Optional

MuRoles

Field	Type	Required
_id	string	Optional
__v	integer	Optional
commanders	array[string]	Optional
managers	array[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.mu.invalidate_cache() -> 'None'

---