Skip to content

Resource MUResource

CrucifiedPain edited this page Jun 26, 2026 · 10 revisions

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 Description
_id `string null` No
__v `integer null` No
name `string null` No
countryId `string null` No
ownerId `string null` No
members `array null` No
damage `number null` No
terrain `number null` No
wealth `number null` No
image `string null` No
description `string null` No
isRecruiting `boolean null` No
activeUpgradeLevels `MuActiveUpgradeLevels null` No
avatarUrl `string null` No
rankings `MuRankings null` No
region `string null` No
roles `MuRoles null` No
user `string null` No
leveling `MuLeveling null` No
investedMoneyByUsers `object null` No
mercenaryReputation `number null` No
lastReputationBuyAt `string null` No
createdAt `string null` No
updatedAt `string null` No

MuActiveUpgradeLevels

Field Type Required Description
_id `string null` No
__v `integer null` No
headquarters `integer null` No
dormitories `integer null` No

MuLeveling

Field Type Required Description
_id `string null` No
__v `integer null` No
level `integer null` No
monthlyDamages `number null` No

MuRankings

Field Type Required Description
_id `string null` No
__v `integer null` No
muWeeklyDamages `RankingDetail null` No
muDamages `RankingDetail null` No
muTerrain `RankingDetail null` No
muWealth `RankingDetail null` No
muBounty `RankingDetail null` No
muReputation `RankingDetail null` No

MuRoles

Field Type Required Description
_id `string null` No
__v `integer null` No
commanders `array null` No
managers `array null` No

RankingDetail

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

.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 Description
_id `string null` No
__v `integer null` No
name `string null` No
countryId `string null` No
ownerId `string null` No
members `array null` No
damage `number null` No
terrain `number null` No
wealth `number null` No
image `string null` No
description `string null` No
isRecruiting `boolean null` No
activeUpgradeLevels `MuActiveUpgradeLevels null` No
avatarUrl `string null` No
rankings `MuRankings null` No
region `string null` No
roles `MuRoles null` No
user `string null` No
leveling `MuLeveling null` No
investedMoneyByUsers `object null` No
mercenaryReputation `number null` No
lastReputationBuyAt `string null` No
createdAt `string null` No
updatedAt `string null` No

MuActiveUpgradeLevels

Field Type Required Description
_id `string null` No
__v `integer null` No
headquarters `integer null` No
dormitories `integer null` No

MuLeveling

Field Type Required Description
_id `string null` No
__v `integer null` No
level `integer null` No
monthlyDamages `number null` No

MuRankings

Field Type Required Description
_id `string null` No
__v `integer null` No
muWeeklyDamages `RankingDetail null` No
muDamages `RankingDetail null` No
muTerrain `RankingDetail null` No
muWealth `RankingDetail null` No
muBounty `RankingDetail null` No
muReputation `RankingDetail null` No

MuRoles

Field Type Required Description
_id `string null` No
__v `integer null` No
commanders `array null` No
managers `array null` No

RankingDetail

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

.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 Description
_id `string null` No
__v `integer null` No
name `string null` No
countryId `string null` No
ownerId `string null` No
members `array null` No
damage `number null` No
terrain `number null` No
wealth `number null` No
image `string null` No
description `string null` No
isRecruiting `boolean null` No
activeUpgradeLevels `MuActiveUpgradeLevels null` No
avatarUrl `string null` No
rankings `MuRankings null` No
region `string null` No
roles `MuRoles null` No
user `string null` No
leveling `MuLeveling null` No
investedMoneyByUsers `object null` No
mercenaryReputation `number null` No
lastReputationBuyAt `string null` No
createdAt `string null` No
updatedAt `string null` No

MuActiveUpgradeLevels

Field Type Required Description
_id `string null` No
__v `integer null` No
headquarters `integer null` No
dormitories `integer null` No

MuLeveling

Field Type Required Description
_id `string null` No
__v `integer null` No
level `integer null` No
monthlyDamages `number null` No

MuRankings

Field Type Required Description
_id `string null` No
__v `integer null` No
muWeeklyDamages `RankingDetail null` No
muDamages `RankingDetail null` No
muTerrain `RankingDetail null` No
muWealth `RankingDetail null` No
muBounty `RankingDetail null` No
muReputation `RankingDetail null` No

MuRoles

Field Type Required Description
_id `string null` No
__v `integer null` No
commanders `array null` No
managers `array null` No

RankingDetail

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

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

Return Models

CursorPage[MilitaryUnit]

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

MilitaryUnit

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

MuActiveUpgradeLevels

Field Type Required Description
_id `string null` No
__v `integer null` No
headquarters `integer null` No
dormitories `integer null` No

MuLeveling

Field Type Required Description
_id `string null` No
__v `integer null` No
level `integer null` No
monthlyDamages `number null` No

MuRankings

Field Type Required Description
_id `string null` No
__v `integer null` No
muWeeklyDamages `RankingDetail null` No
muDamages `RankingDetail null` No
muTerrain `RankingDetail null` No
muWealth `RankingDetail null` No
muBounty `RankingDetail null` No
muReputation `RankingDetail null` No

MuRoles

Field Type Required Description
_id `string null` No
__v `integer null` No
commanders `array null` No
managers `array null` No

RankingDetail

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

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

Clone this wiki locally