Resource UserResource

UserResource (`client.user`)

Endpoints: • user.getUserById • user.getUserLite • user.getUsersByCountry (cursor-paginated)

`.collect_all()`

Fetch every user from every country concurrently using auto pagination.

This is the fastest way to retrieve all users in the game. It:

Fetches all country IDs via country.getAllCountries.
Concurrently paginates through users for all countries.

Args: concurrency: Max concurrent requests.

Returns: A flat list of all :class:UserLite objects across every country.

Signature

await client.user.collect_all(*, concurrency: 'int' = 500) -> 'list[UserLite]'

Parameters

Name	Type	Default
`concurrency`	`int`	`500`

Return Models

`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

`SkillDetail`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`level`	`integer	null`	No
`currentBarValue`	`number	null`	No
`value`	`number	null`	No
`weapon`	`number	null`	No
`equipment`	`number	null`	No
`limited`	`number	null`	No
`total`	`number	null`	No
`hourlyBarRegen`	`number	null`	No
`totalAfterSoftCap`	`number	null`	No
`overflow`	`number	null`	No
`ammoPercent`	`number	null`	No
`buffsPercent`	`number	null`	No
`debuffsPercent`	`number	null`	No
`militaryRankPercent`	`number	null`	No

`UserDates`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`lastConnectionAt`	`string	null`	No
`lastTakingControlAt`	`string	null`	No
`lastNotificationsCheckAt`	`string	null`	No
`lastCountryMessageCheckAt`	`string	null`	No
`lastGlobalMessageCheckAt`	`string	null`	No
`lastEventsCheckAt`	`string	null`	No
`lastWorkOfferApplications`	`array[string]	null`	No
`lastHiresAt`	`array[string]	null`	No
`lastWorkAt`	`string	null`	No
`lastCompanyJoinedAt`	`string	null`	No
`lastDailyRewardClaimedAt`	`string	null`	No
`lastSkillsResetAt`	`string	null`	No
`lastHelpAskedAt`	`string	null`	No
`lastCitizenshipChangeAt`	`string	null`	No

`UserInfos`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`colorScheme`	`string	null`	No
`description`	`string	null`	No
`font`	`string	null`	No
`isPremium`	`boolean	null`	No
`premiumGiftsCount`	`integer	null`	No
`premiumMonthsCount`	`integer	null`	No
`vicePresidentOf`	`string	null`	No

`UserLeveling`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`level`	`integer	null`	No
`totalXp`	`integer	null`	No
`dailyXpLeft`	`integer	null`	No
`availableSkillPoints`	`integer	null`	No
`spentSkillPoints`	`integer	null`	No
`totalSkillPoints`	`integer	null`	No
`freeReset`	`integer	null`	No

`UserLite`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`username`	`string	null`	No
`usernameLower`	`string	null`	No
`canOnboard`	`boolean	null`	No
`country`	`string	null`	No
`isActive`	`boolean	null`	No
`avatarUrl`	`string	null`	No
`mu`	`string	null`	No
`militaryRank`	`integer	null`	No
`createdAt`	`string	null`	No
`updatedAt`	`string	null`	No
`emailVerified`	`boolean	null`	No
`dates`	`UserDates	null`	No
`leveling`	`UserLeveling	null`	No
`stats`	`UserStats	null`	No
`rankings`	`UserRankings	null`	No
`infos`	`UserInfos	null`	No
`skills`	`UserSkills	null`	No
`equippedSkinKeys`	`object	null`	No

`UserRankings`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`userDamages`	`RankingDetail	null`	No
`weeklyUserDamages`	`RankingDetail	null`	No
`userWealth`	`RankingDetail	null`	No
`userLevel`	`RankingDetail	null`	No
`userReferrals`	`RankingDetail	null`	No
`userTerrain`	`RankingDetail	null`	No
`userCasesOpened`	`RankingDetail	null`	No
`userBounty`	`RankingDetail	null`	No
`userGemsPurchased`	`RankingDetail	null`	No
`userPremiumGifts`	`RankingDetail	null`	No
`userPremiumMonths`	`RankingDetail	null`	No
`userSubscribers`	`RankingDetail	null`	No

`UserSkills`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`energy`	`SkillDetail	null`	No
`health`	`SkillDetail	null`	No
`hunger`	`SkillDetail	null`	No
`attack`	`SkillDetail	null`	No
`companies`	`SkillDetail	null`	No
`entrepreneurship`	`SkillDetail	null`	No
`production`	`SkillDetail	null`	No
`criticalChance`	`SkillDetail	null`	No
`criticalDamages`	`SkillDetail	null`	No
`armor`	`SkillDetail	null`	No
`precision`	`SkillDetail	null`	No
`dodge`	`SkillDetail	null`	No
`lootChance`	`SkillDetail	null`	No
`management`	`SkillDetail	null`	No

`UserStats`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`estimatedCompanyValues`	`number	null`	No
`estimatedInventoryValue`	`number	null`	No
`estimatedWealth`	`number	null`	No
`worksCount`	`integer	null`	No
`damagesCount`	`integer	null`	No
`wealth`	`UserStatsWealth	null`	No
`case1`	`UserStatsCase1	null`	No

`UserStatsCase1`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`byRarity`	`UserStatsCase1ByRarity	null`	No
`openedCount`	`integer	null`	No

`UserStatsCase1ByRarity`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`common`	`integer	null`	No
`uncommon`	`integer	null`	No
`rare`	`integer	null`	No
`epic`	`integer	null`	No
`legendary`	`integer	null`	No

`UserStatsWealth`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`companies`	`number	null`	No
`items`	`number	null`	No
`money`	`number	null`	No
`equipments`	`number	null`	No
`weapons`	`number	null`	No
`total`	`number	null`	No

`.collect_by_country()`

Return all users in a country as a flat list, fetched in parallel.

Signature

await client.user.collect_by_country(country_id: 'str', oldest_date: 'datetime | str | None' = None, time_slice_days: 'int' = 30, concurrency: 'int' = 500, **kwargs: 'Any') -> 'list[UserLite]'

Parameters

Name	Type	Default
`country_id`	`str`	`Required`
`oldest_date`	`datetime	str
`time_slice_days`	`int`	`30`
`concurrency`	`int`	`500`
`kwargs`	`Any`	`Required`

Return Models

`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

`SkillDetail`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`level`	`integer	null`	No
`currentBarValue`	`number	null`	No
`value`	`number	null`	No
`weapon`	`number	null`	No
`equipment`	`number	null`	No
`limited`	`number	null`	No
`total`	`number	null`	No
`hourlyBarRegen`	`number	null`	No
`totalAfterSoftCap`	`number	null`	No
`overflow`	`number	null`	No
`ammoPercent`	`number	null`	No
`buffsPercent`	`number	null`	No
`debuffsPercent`	`number	null`	No
`militaryRankPercent`	`number	null`	No

`UserDates`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`lastConnectionAt`	`string	null`	No
`lastTakingControlAt`	`string	null`	No
`lastNotificationsCheckAt`	`string	null`	No
`lastCountryMessageCheckAt`	`string	null`	No
`lastGlobalMessageCheckAt`	`string	null`	No
`lastEventsCheckAt`	`string	null`	No
`lastWorkOfferApplications`	`array[string]	null`	No
`lastHiresAt`	`array[string]	null`	No
`lastWorkAt`	`string	null`	No
`lastCompanyJoinedAt`	`string	null`	No
`lastDailyRewardClaimedAt`	`string	null`	No
`lastSkillsResetAt`	`string	null`	No
`lastHelpAskedAt`	`string	null`	No
`lastCitizenshipChangeAt`	`string	null`	No

`UserInfos`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`colorScheme`	`string	null`	No
`description`	`string	null`	No
`font`	`string	null`	No
`isPremium`	`boolean	null`	No
`premiumGiftsCount`	`integer	null`	No
`premiumMonthsCount`	`integer	null`	No
`vicePresidentOf`	`string	null`	No

`UserLeveling`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`level`	`integer	null`	No
`totalXp`	`integer	null`	No
`dailyXpLeft`	`integer	null`	No
`availableSkillPoints`	`integer	null`	No
`spentSkillPoints`	`integer	null`	No
`totalSkillPoints`	`integer	null`	No
`freeReset`	`integer	null`	No

`UserLite`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`username`	`string	null`	No
`usernameLower`	`string	null`	No
`canOnboard`	`boolean	null`	No
`country`	`string	null`	No
`isActive`	`boolean	null`	No
`avatarUrl`	`string	null`	No
`mu`	`string	null`	No
`militaryRank`	`integer	null`	No
`createdAt`	`string	null`	No
`updatedAt`	`string	null`	No
`emailVerified`	`boolean	null`	No
`dates`	`UserDates	null`	No
`leveling`	`UserLeveling	null`	No
`stats`	`UserStats	null`	No
`rankings`	`UserRankings	null`	No
`infos`	`UserInfos	null`	No
`skills`	`UserSkills	null`	No
`equippedSkinKeys`	`object	null`	No

`UserRankings`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`userDamages`	`RankingDetail	null`	No
`weeklyUserDamages`	`RankingDetail	null`	No
`userWealth`	`RankingDetail	null`	No
`userLevel`	`RankingDetail	null`	No
`userReferrals`	`RankingDetail	null`	No
`userTerrain`	`RankingDetail	null`	No
`userCasesOpened`	`RankingDetail	null`	No
`userBounty`	`RankingDetail	null`	No
`userGemsPurchased`	`RankingDetail	null`	No
`userPremiumGifts`	`RankingDetail	null`	No
`userPremiumMonths`	`RankingDetail	null`	No
`userSubscribers`	`RankingDetail	null`	No

`UserSkills`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`energy`	`SkillDetail	null`	No
`health`	`SkillDetail	null`	No
`hunger`	`SkillDetail	null`	No
`attack`	`SkillDetail	null`	No
`companies`	`SkillDetail	null`	No
`entrepreneurship`	`SkillDetail	null`	No
`production`	`SkillDetail	null`	No
`criticalChance`	`SkillDetail	null`	No
`criticalDamages`	`SkillDetail	null`	No
`armor`	`SkillDetail	null`	No
`precision`	`SkillDetail	null`	No
`dodge`	`SkillDetail	null`	No
`lootChance`	`SkillDetail	null`	No
`management`	`SkillDetail	null`	No

`UserStats`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`estimatedCompanyValues`	`number	null`	No
`estimatedInventoryValue`	`number	null`	No
`estimatedWealth`	`number	null`	No
`worksCount`	`integer	null`	No
`damagesCount`	`integer	null`	No
`wealth`	`UserStatsWealth	null`	No
`case1`	`UserStatsCase1	null`	No

`UserStatsCase1`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`byRarity`	`UserStatsCase1ByRarity	null`	No
`openedCount`	`integer	null`	No

`UserStatsCase1ByRarity`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`common`	`integer	null`	No
`uncommon`	`integer	null`	No
`rare`	`integer	null`	No
`epic`	`integer	null`	No
`legendary`	`integer	null`	No

`UserStatsWealth`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`companies`	`number	null`	No
`items`	`number	null`	No
`money`	`number	null`	No
`equipments`	`number	null`	No
`weapons`	`number	null`	No
`total`	`number	null`	No

`.get_by_country()`

Get users belonging to a country (cursor-paginated).

Signature

await client.user.get_by_country(country_id: 'str', *, limit: 'int' = 10, cursor: 'str | None' = None, auto_items: 'bool' = False, max_pages: 'int | float' = inf, cursor_end: 'str | None' = None) -> 'CursorPage[UserLite] | AsyncIterator[UserLite]'

Parameters

Name	Type	Default
`country_id`	`str`	`Required`
`limit`	`int`	`10`
`cursor`	`str	None`
`auto_items`	`bool`	`False`
`max_pages`	`int	float`
`cursor_end`	`str	None`

Return Models

`CursorPage[UserLite]`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`items`	`array[UserLite]`	Yes
`nextCursor`	`string	null`	No
`hasMore`	`boolean`	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

`SkillDetail`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`level`	`integer	null`	No
`currentBarValue`	`number	null`	No
`value`	`number	null`	No
`weapon`	`number	null`	No
`equipment`	`number	null`	No
`limited`	`number	null`	No
`total`	`number	null`	No
`hourlyBarRegen`	`number	null`	No
`totalAfterSoftCap`	`number	null`	No
`overflow`	`number	null`	No
`ammoPercent`	`number	null`	No
`buffsPercent`	`number	null`	No
`debuffsPercent`	`number	null`	No
`militaryRankPercent`	`number	null`	No

`UserDates`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`lastConnectionAt`	`string	null`	No
`lastTakingControlAt`	`string	null`	No
`lastNotificationsCheckAt`	`string	null`	No
`lastCountryMessageCheckAt`	`string	null`	No
`lastGlobalMessageCheckAt`	`string	null`	No
`lastEventsCheckAt`	`string	null`	No
`lastWorkOfferApplications`	`array[string]	null`	No
`lastHiresAt`	`array[string]	null`	No
`lastWorkAt`	`string	null`	No
`lastCompanyJoinedAt`	`string	null`	No
`lastDailyRewardClaimedAt`	`string	null`	No
`lastSkillsResetAt`	`string	null`	No
`lastHelpAskedAt`	`string	null`	No
`lastCitizenshipChangeAt`	`string	null`	No

`UserInfos`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`colorScheme`	`string	null`	No
`description`	`string	null`	No
`font`	`string	null`	No
`isPremium`	`boolean	null`	No
`premiumGiftsCount`	`integer	null`	No
`premiumMonthsCount`	`integer	null`	No
`vicePresidentOf`	`string	null`	No

`UserLeveling`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`level`	`integer	null`	No
`totalXp`	`integer	null`	No
`dailyXpLeft`	`integer	null`	No
`availableSkillPoints`	`integer	null`	No
`spentSkillPoints`	`integer	null`	No
`totalSkillPoints`	`integer	null`	No
`freeReset`	`integer	null`	No

`UserLite`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`username`	`string	null`	No
`usernameLower`	`string	null`	No
`canOnboard`	`boolean	null`	No
`country`	`string	null`	No
`isActive`	`boolean	null`	No
`avatarUrl`	`string	null`	No
`mu`	`string	null`	No
`militaryRank`	`integer	null`	No
`createdAt`	`string	null`	No
`updatedAt`	`string	null`	No
`emailVerified`	`boolean	null`	No
`dates`	`UserDates	null`	No
`leveling`	`UserLeveling	null`	No
`stats`	`UserStats	null`	No
`rankings`	`UserRankings	null`	No
`infos`	`UserInfos	null`	No
`skills`	`UserSkills	null`	No
`equippedSkinKeys`	`object	null`	No

`UserRankings`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`userDamages`	`RankingDetail	null`	No
`weeklyUserDamages`	`RankingDetail	null`	No
`userWealth`	`RankingDetail	null`	No
`userLevel`	`RankingDetail	null`	No
`userReferrals`	`RankingDetail	null`	No
`userTerrain`	`RankingDetail	null`	No
`userCasesOpened`	`RankingDetail	null`	No
`userBounty`	`RankingDetail	null`	No
`userGemsPurchased`	`RankingDetail	null`	No
`userPremiumGifts`	`RankingDetail	null`	No
`userPremiumMonths`	`RankingDetail	null`	No
`userSubscribers`	`RankingDetail	null`	No

`UserSkills`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`energy`	`SkillDetail	null`	No
`health`	`SkillDetail	null`	No
`hunger`	`SkillDetail	null`	No
`attack`	`SkillDetail	null`	No
`companies`	`SkillDetail	null`	No
`entrepreneurship`	`SkillDetail	null`	No
`production`	`SkillDetail	null`	No
`criticalChance`	`SkillDetail	null`	No
`criticalDamages`	`SkillDetail	null`	No
`armor`	`SkillDetail	null`	No
`precision`	`SkillDetail	null`	No
`dodge`	`SkillDetail	null`	No
`lootChance`	`SkillDetail	null`	No
`management`	`SkillDetail	null`	No

`UserStats`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`estimatedCompanyValues`	`number	null`	No
`estimatedInventoryValue`	`number	null`	No
`estimatedWealth`	`number	null`	No
`worksCount`	`integer	null`	No
`damagesCount`	`integer	null`	No
`wealth`	`UserStatsWealth	null`	No
`case1`	`UserStatsCase1	null`	No

`UserStatsCase1`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`byRarity`	`UserStatsCase1ByRarity	null`	No
`openedCount`	`integer	null`	No

`UserStatsCase1ByRarity`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`common`	`integer	null`	No
`uncommon`	`integer	null`	No
`rare`	`integer	null`	No
`epic`	`integer	null`	No
`legendary`	`integer	null`	No

`UserStatsWealth`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`companies`	`number	null`	No
`items`	`number	null`	No
`money`	`number	null`	No
`equipments`	`number	null`	No
`weapons`	`number	null`	No
`total`	`number	null`	No

`.get_by_id()`

Get a user's profile by ID.

Signature

await client.user.get_by_id(user_id: 'str') -> 'User'

Parameters

Name	Type	Default
`user_id`	`str`	`Required`

Return Models

`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

`SkillDetail`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`level`	`integer	null`	No
`currentBarValue`	`number	null`	No
`value`	`number	null`	No
`weapon`	`number	null`	No
`equipment`	`number	null`	No
`limited`	`number	null`	No
`total`	`number	null`	No
`hourlyBarRegen`	`number	null`	No
`totalAfterSoftCap`	`number	null`	No
`overflow`	`number	null`	No
`ammoPercent`	`number	null`	No
`buffsPercent`	`number	null`	No
`debuffsPercent`	`number	null`	No
`militaryRankPercent`	`number	null`	No

`User`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`username`	`string	null`	No
`usernameLower`	`string	null`	No
`canOnboard`	`boolean	null`	No
`country`	`string	null`	No
`isActive`	`boolean	null`	No
`avatarUrl`	`string	null`	No
`mu`	`string	null`	No
`militaryRank`	`integer	null`	No
`createdAt`	`string	null`	No
`updatedAt`	`string	null`	No
`emailVerified`	`boolean	null`	No
`dates`	`UserDates	null`	No
`leveling`	`UserLeveling	null`	No
`stats`	`UserStats	null`	No
`rankings`	`UserRankings	null`	No
`infos`	`UserInfos	null`	No
`skills`	`UserSkills	null`	No
`equippedSkinKeys`	`object	null`	No
`missions`	`UserMissions	null`	No
`equipment`	`UserEquipment	null`	No
`party`	`string	null`	No
`company`	`string	null`	No
`muMaxLevelRewarded`	`integer	null`	No
`availableColorSchemes`	`array[string]	null`	No
`finishedTours`	`object	null`	No
`shouldUpdateProfile`	`boolean	null`	No
`orgs`	`array[string]	null`	No
`preferences`	`UserPreferences	null`	No

`UserDates`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`lastConnectionAt`	`string	null`	No
`lastTakingControlAt`	`string	null`	No
`lastNotificationsCheckAt`	`string	null`	No
`lastCountryMessageCheckAt`	`string	null`	No
`lastGlobalMessageCheckAt`	`string	null`	No
`lastEventsCheckAt`	`string	null`	No
`lastWorkOfferApplications`	`array[string]	null`	No
`lastHiresAt`	`array[string]	null`	No
`lastWorkAt`	`string	null`	No
`lastCompanyJoinedAt`	`string	null`	No
`lastDailyRewardClaimedAt`	`string	null`	No
`lastSkillsResetAt`	`string	null`	No
`lastHelpAskedAt`	`string	null`	No
`lastCitizenshipChangeAt`	`string	null`	No

`UserEquipment`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`ammo`	`string	null`	No
`helmet`	`string	null`	No
`chest`	`string	null`	No
`boots`	`string	null`	No
`pants`	`string	null`	No
`gloves`	`string	null`	No
`weapon`	`string	null`	No

`UserInfos`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`colorScheme`	`string	null`	No
`description`	`string	null`	No
`font`	`string	null`	No
`isPremium`	`boolean	null`	No
`premiumGiftsCount`	`integer	null`	No
`premiumMonthsCount`	`integer	null`	No
`vicePresidentOf`	`string	null`	No

`UserLeveling`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`level`	`integer	null`	No
`totalXp`	`integer	null`	No
`dailyXpLeft`	`integer	null`	No
`availableSkillPoints`	`integer	null`	No
`spentSkillPoints`	`integer	null`	No
`totalSkillPoints`	`integer	null`	No
`freeReset`	`integer	null`	No

`UserMissions`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`claimedAt`	`UserMissionsClaimedAt	null`	No
`rerolledDailyMissions`	`integer	null`	No
`rerolledWeeklyMissions`	`integer	null`	No

`UserMissionsClaimedAt`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`starting`	`string	null`	No
`daily`	`string	null`	No
`weekly`	`string	null`	No
`monthly`	`string	null`	No

`UserPreferences`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`autoReplaceOnBreak`	`boolean	null`	No
`autoEquipMode`	`string	null`	No
`appFont`	`string	null`	No
`appPattern`	`string	null`	No
`locale`	`string	null`	No
`sfx`	`boolean	null`	No
`colorblind`	`boolean	null`	No

`UserRankings`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`userDamages`	`RankingDetail	null`	No
`weeklyUserDamages`	`RankingDetail	null`	No
`userWealth`	`RankingDetail	null`	No
`userLevel`	`RankingDetail	null`	No
`userReferrals`	`RankingDetail	null`	No
`userTerrain`	`RankingDetail	null`	No
`userCasesOpened`	`RankingDetail	null`	No
`userBounty`	`RankingDetail	null`	No
`userGemsPurchased`	`RankingDetail	null`	No
`userPremiumGifts`	`RankingDetail	null`	No
`userPremiumMonths`	`RankingDetail	null`	No
`userSubscribers`	`RankingDetail	null`	No

`UserSkills`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`energy`	`SkillDetail	null`	No
`health`	`SkillDetail	null`	No
`hunger`	`SkillDetail	null`	No
`attack`	`SkillDetail	null`	No
`companies`	`SkillDetail	null`	No
`entrepreneurship`	`SkillDetail	null`	No
`production`	`SkillDetail	null`	No
`criticalChance`	`SkillDetail	null`	No
`criticalDamages`	`SkillDetail	null`	No
`armor`	`SkillDetail	null`	No
`precision`	`SkillDetail	null`	No
`dodge`	`SkillDetail	null`	No
`lootChance`	`SkillDetail	null`	No
`management`	`SkillDetail	null`	No

`UserStats`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`estimatedCompanyValues`	`number	null`	No
`estimatedInventoryValue`	`number	null`	No
`estimatedWealth`	`number	null`	No
`worksCount`	`integer	null`	No
`damagesCount`	`integer	null`	No
`wealth`	`UserStatsWealth	null`	No
`case1`	`UserStatsCase1	null`	No

`UserStatsCase1`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`byRarity`	`UserStatsCase1ByRarity	null`	No
`openedCount`	`integer	null`	No

`UserStatsCase1ByRarity`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`common`	`integer	null`	No
`uncommon`	`integer	null`	No
`rare`	`integer	null`	No
`epic`	`integer	null`	No
`legendary`	`integer	null`	No

`UserStatsWealth`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`companies`	`number	null`	No
`items`	`number	null`	No
`money`	`number	null`	No
`equipments`	`number	null`	No
`weapons`	`number	null`	No
`total`	`number	null`	No

`.get_lite()`

Get a user's lite profile by ID. (Deprecated in favor of get_by_id)

Signature

await client.user.get_lite(user_id: 'str') -> 'UserLite'

Parameters

Name	Type	Default
`user_id`	`str`	`Required`

Return Models

`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

`SkillDetail`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`level`	`integer	null`	No
`currentBarValue`	`number	null`	No
`value`	`number	null`	No
`weapon`	`number	null`	No
`equipment`	`number	null`	No
`limited`	`number	null`	No
`total`	`number	null`	No
`hourlyBarRegen`	`number	null`	No
`totalAfterSoftCap`	`number	null`	No
`overflow`	`number	null`	No
`ammoPercent`	`number	null`	No
`buffsPercent`	`number	null`	No
`debuffsPercent`	`number	null`	No
`militaryRankPercent`	`number	null`	No

`UserDates`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`lastConnectionAt`	`string	null`	No
`lastTakingControlAt`	`string	null`	No
`lastNotificationsCheckAt`	`string	null`	No
`lastCountryMessageCheckAt`	`string	null`	No
`lastGlobalMessageCheckAt`	`string	null`	No
`lastEventsCheckAt`	`string	null`	No
`lastWorkOfferApplications`	`array[string]	null`	No
`lastHiresAt`	`array[string]	null`	No
`lastWorkAt`	`string	null`	No
`lastCompanyJoinedAt`	`string	null`	No
`lastDailyRewardClaimedAt`	`string	null`	No
`lastSkillsResetAt`	`string	null`	No
`lastHelpAskedAt`	`string	null`	No
`lastCitizenshipChangeAt`	`string	null`	No

`UserInfos`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`colorScheme`	`string	null`	No
`description`	`string	null`	No
`font`	`string	null`	No
`isPremium`	`boolean	null`	No
`premiumGiftsCount`	`integer	null`	No
`premiumMonthsCount`	`integer	null`	No
`vicePresidentOf`	`string	null`	No

`UserLeveling`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`level`	`integer	null`	No
`totalXp`	`integer	null`	No
`dailyXpLeft`	`integer	null`	No
`availableSkillPoints`	`integer	null`	No
`spentSkillPoints`	`integer	null`	No
`totalSkillPoints`	`integer	null`	No
`freeReset`	`integer	null`	No

`UserLite`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`username`	`string	null`	No
`usernameLower`	`string	null`	No
`canOnboard`	`boolean	null`	No
`country`	`string	null`	No
`isActive`	`boolean	null`	No
`avatarUrl`	`string	null`	No
`mu`	`string	null`	No
`militaryRank`	`integer	null`	No
`createdAt`	`string	null`	No
`updatedAt`	`string	null`	No
`emailVerified`	`boolean	null`	No
`dates`	`UserDates	null`	No
`leveling`	`UserLeveling	null`	No
`stats`	`UserStats	null`	No
`rankings`	`UserRankings	null`	No
`infos`	`UserInfos	null`	No
`skills`	`UserSkills	null`	No
`equippedSkinKeys`	`object	null`	No

`UserRankings`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`userDamages`	`RankingDetail	null`	No
`weeklyUserDamages`	`RankingDetail	null`	No
`userWealth`	`RankingDetail	null`	No
`userLevel`	`RankingDetail	null`	No
`userReferrals`	`RankingDetail	null`	No
`userTerrain`	`RankingDetail	null`	No
`userCasesOpened`	`RankingDetail	null`	No
`userBounty`	`RankingDetail	null`	No
`userGemsPurchased`	`RankingDetail	null`	No
`userPremiumGifts`	`RankingDetail	null`	No
`userPremiumMonths`	`RankingDetail	null`	No
`userSubscribers`	`RankingDetail	null`	No

`UserSkills`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`energy`	`SkillDetail	null`	No
`health`	`SkillDetail	null`	No
`hunger`	`SkillDetail	null`	No
`attack`	`SkillDetail	null`	No
`companies`	`SkillDetail	null`	No
`entrepreneurship`	`SkillDetail	null`	No
`production`	`SkillDetail	null`	No
`criticalChance`	`SkillDetail	null`	No
`criticalDamages`	`SkillDetail	null`	No
`armor`	`SkillDetail	null`	No
`precision`	`SkillDetail	null`	No
`dodge`	`SkillDetail	null`	No
`lootChance`	`SkillDetail	null`	No
`management`	`SkillDetail	null`	No

`UserStats`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`estimatedCompanyValues`	`number	null`	No
`estimatedInventoryValue`	`number	null`	No
`estimatedWealth`	`number	null`	No
`worksCount`	`integer	null`	No
`damagesCount`	`integer	null`	No
`wealth`	`UserStatsWealth	null`	No
`case1`	`UserStatsCase1	null`	No

`UserStatsCase1`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`byRarity`	`UserStatsCase1ByRarity	null`	No
`openedCount`	`integer	null`	No

`UserStatsCase1ByRarity`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`common`	`integer	null`	No
`uncommon`	`integer	null`	No
`rare`	`integer	null`	No
`epic`	`integer	null`	No
`legendary`	`integer	null`	No

`UserStatsWealth`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`companies`	`number	null`	No
`items`	`number	null`	No
`money`	`number	null`	No
`equipments`	`number	null`	No
`weapons`	`number	null`	No
`total`	`number	null`	No

`.get_many()`

Fetch multiple users by ID concurrently using the auto-batcher.

Signature

await client.user.get_many(user_ids: 'list[str]', *, concurrency: 'int' = 500) -> 'list[User | None]'

Parameters

Name	Type	Default
`user_ids`	`list[str]`	`Required`
`concurrency`	`int`	`500`

Return Models

`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

`SkillDetail`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`level`	`integer	null`	No
`currentBarValue`	`number	null`	No
`value`	`number	null`	No
`weapon`	`number	null`	No
`equipment`	`number	null`	No
`limited`	`number	null`	No
`total`	`number	null`	No
`hourlyBarRegen`	`number	null`	No
`totalAfterSoftCap`	`number	null`	No
`overflow`	`number	null`	No
`ammoPercent`	`number	null`	No
`buffsPercent`	`number	null`	No
`debuffsPercent`	`number	null`	No
`militaryRankPercent`	`number	null`	No

`User`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`username`	`string	null`	No
`usernameLower`	`string	null`	No
`canOnboard`	`boolean	null`	No
`country`	`string	null`	No
`isActive`	`boolean	null`	No
`avatarUrl`	`string	null`	No
`mu`	`string	null`	No
`militaryRank`	`integer	null`	No
`createdAt`	`string	null`	No
`updatedAt`	`string	null`	No
`emailVerified`	`boolean	null`	No
`dates`	`UserDates	null`	No
`leveling`	`UserLeveling	null`	No
`stats`	`UserStats	null`	No
`rankings`	`UserRankings	null`	No
`infos`	`UserInfos	null`	No
`skills`	`UserSkills	null`	No
`equippedSkinKeys`	`object	null`	No
`missions`	`UserMissions	null`	No
`equipment`	`UserEquipment	null`	No
`party`	`string	null`	No
`company`	`string	null`	No
`muMaxLevelRewarded`	`integer	null`	No
`availableColorSchemes`	`array[string]	null`	No
`finishedTours`	`object	null`	No
`shouldUpdateProfile`	`boolean	null`	No
`orgs`	`array[string]	null`	No
`preferences`	`UserPreferences	null`	No

`UserDates`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`lastConnectionAt`	`string	null`	No
`lastTakingControlAt`	`string	null`	No
`lastNotificationsCheckAt`	`string	null`	No
`lastCountryMessageCheckAt`	`string	null`	No
`lastGlobalMessageCheckAt`	`string	null`	No
`lastEventsCheckAt`	`string	null`	No
`lastWorkOfferApplications`	`array[string]	null`	No
`lastHiresAt`	`array[string]	null`	No
`lastWorkAt`	`string	null`	No
`lastCompanyJoinedAt`	`string	null`	No
`lastDailyRewardClaimedAt`	`string	null`	No
`lastSkillsResetAt`	`string	null`	No
`lastHelpAskedAt`	`string	null`	No
`lastCitizenshipChangeAt`	`string	null`	No

`UserEquipment`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`ammo`	`string	null`	No
`helmet`	`string	null`	No
`chest`	`string	null`	No
`boots`	`string	null`	No
`pants`	`string	null`	No
`gloves`	`string	null`	No
`weapon`	`string	null`	No

`UserInfos`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`colorScheme`	`string	null`	No
`description`	`string	null`	No
`font`	`string	null`	No
`isPremium`	`boolean	null`	No
`premiumGiftsCount`	`integer	null`	No
`premiumMonthsCount`	`integer	null`	No
`vicePresidentOf`	`string	null`	No

`UserLeveling`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`level`	`integer	null`	No
`totalXp`	`integer	null`	No
`dailyXpLeft`	`integer	null`	No
`availableSkillPoints`	`integer	null`	No
`spentSkillPoints`	`integer	null`	No
`totalSkillPoints`	`integer	null`	No
`freeReset`	`integer	null`	No

`UserMissions`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`claimedAt`	`UserMissionsClaimedAt	null`	No
`rerolledDailyMissions`	`integer	null`	No
`rerolledWeeklyMissions`	`integer	null`	No

`UserMissionsClaimedAt`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`starting`	`string	null`	No
`daily`	`string	null`	No
`weekly`	`string	null`	No
`monthly`	`string	null`	No

`UserPreferences`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`autoReplaceOnBreak`	`boolean	null`	No
`autoEquipMode`	`string	null`	No
`appFont`	`string	null`	No
`appPattern`	`string	null`	No
`locale`	`string	null`	No
`sfx`	`boolean	null`	No
`colorblind`	`boolean	null`	No

`UserRankings`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`userDamages`	`RankingDetail	null`	No
`weeklyUserDamages`	`RankingDetail	null`	No
`userWealth`	`RankingDetail	null`	No
`userLevel`	`RankingDetail	null`	No
`userReferrals`	`RankingDetail	null`	No
`userTerrain`	`RankingDetail	null`	No
`userCasesOpened`	`RankingDetail	null`	No
`userBounty`	`RankingDetail	null`	No
`userGemsPurchased`	`RankingDetail	null`	No
`userPremiumGifts`	`RankingDetail	null`	No
`userPremiumMonths`	`RankingDetail	null`	No
`userSubscribers`	`RankingDetail	null`	No

`UserSkills`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`energy`	`SkillDetail	null`	No
`health`	`SkillDetail	null`	No
`hunger`	`SkillDetail	null`	No
`attack`	`SkillDetail	null`	No
`companies`	`SkillDetail	null`	No
`entrepreneurship`	`SkillDetail	null`	No
`production`	`SkillDetail	null`	No
`criticalChance`	`SkillDetail	null`	No
`criticalDamages`	`SkillDetail	null`	No
`armor`	`SkillDetail	null`	No
`precision`	`SkillDetail	null`	No
`dodge`	`SkillDetail	null`	No
`lootChance`	`SkillDetail	null`	No
`management`	`SkillDetail	null`	No

`UserStats`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`estimatedCompanyValues`	`number	null`	No
`estimatedInventoryValue`	`number	null`	No
`estimatedWealth`	`number	null`	No
`worksCount`	`integer	null`	No
`damagesCount`	`integer	null`	No
`wealth`	`UserStatsWealth	null`	No
`case1`	`UserStatsCase1	null`	No

`UserStatsCase1`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`byRarity`	`UserStatsCase1ByRarity	null`	No
`openedCount`	`integer	null`	No

`UserStatsCase1ByRarity`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`common`	`integer	null`	No
`uncommon`	`integer	null`	No
`rare`	`integer	null`	No
`epic`	`integer	null`	No
`legendary`	`integer	null`	No

`UserStatsWealth`

Field	Type	Required	Description
`_id`	`string	null`	No
`__v`	`integer	null`	No
`companies`	`number	null`	No
`items`	`number	null`	No
`money`	`number	null`	No
`equipments`	`number	null`	No
`weapons`	`number	null`	No
`total`	`number	null`	No

`.invalidate_cache()`

Clear the SWR cache for all resources.

Signature

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

Uh oh!

Resource UserResource

UserResource (client.user)

.collect_all()

Signature

Parameters

Return Models

RankingDetail

SkillDetail

UserDates

UserInfos

UserLeveling

UserLite

UserRankings

UserSkills

UserStats

UserStatsCase1

UserStatsCase1ByRarity

UserStatsWealth

.collect_by_country()

Signature

Parameters

Return Models

RankingDetail

SkillDetail

UserDates

UserInfos

UserLeveling

UserLite

UserRankings

UserSkills

UserStats

UserStatsCase1

UserStatsCase1ByRarity

UserStatsWealth

.get_by_country()

Signature

Parameters

Return Models

CursorPage[UserLite]

RankingDetail

SkillDetail

UserDates

UserInfos

UserLeveling

UserLite

UserRankings

UserSkills

UserStats

UserStatsCase1

UserStatsCase1ByRarity

UserStatsWealth

.get_by_id()

Signature

Parameters

Return Models

RankingDetail

SkillDetail

User

UserDates

UserEquipment

UserInfos

UserLeveling

UserMissions

UserMissionsClaimedAt

UserPreferences

UserRankings

UserSkills

UserStats

UserStatsCase1

UserStatsCase1ByRarity

UserStatsWealth

.get_lite()

Signature

Parameters

Return Models

RankingDetail

SkillDetail

UserDates

UserInfos

UserResource (`client.user`)

`.collect_all()`

`RankingDetail`

`SkillDetail`

`UserDates`

`UserInfos`

`UserLeveling`

`UserLite`

`UserRankings`

`UserSkills`

`UserStats`

`UserStatsCase1`

`UserStatsCase1ByRarity`

`UserStatsWealth`

`.collect_by_country()`

`RankingDetail`

`SkillDetail`

`UserDates`

`UserInfos`

`UserLeveling`

`UserLite`

`UserRankings`

`UserSkills`

`UserStats`

`UserStatsCase1`

`UserStatsCase1ByRarity`

`UserStatsWealth`

`.get_by_country()`

`CursorPage[UserLite]`

`RankingDetail`

`SkillDetail`

`UserDates`

`UserInfos`

`UserLeveling`

`UserLite`

`UserRankings`

`UserSkills`

`UserStats`

`UserStatsCase1`

`UserStatsCase1ByRarity`

`UserStatsWealth`

`.get_by_id()`

`RankingDetail`

`SkillDetail`

`User`

`UserDates`

`UserEquipment`

`UserInfos`

`UserLeveling`

`UserMissions`

`UserMissionsClaimedAt`

`UserPreferences`

`UserRankings`

`UserSkills`

`UserStats`

`UserStatsCase1`

`UserStatsCase1ByRarity`

`UserStatsWealth`

`.get_lite()`

`RankingDetail`

`SkillDetail`

`UserDates`

`UserInfos`

`UserLeveling`

`UserLite`

`UserRankings`

`UserSkills`

`UserStats`

`UserStatsCase1`

`UserStatsCase1ByRarity`

`UserStatsWealth`

`.get_many()`

`RankingDetail`

`SkillDetail`

`User`

`UserDates`

`UserEquipment`

`UserInfos`

`UserLeveling`

`UserMissions`