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: 1. Fetches all country IDs via country.getAllCountries. 2. 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
`_id`	`string`	Optional
`__v`	`integer`	Optional
`value`	`number`	Optional
`rank`	`integer`	Optional
`tier`	`string`	Optional
`country`	`string`	Optional

`SkillDetail`¶

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

`UserDates`¶

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

`UserInfos`¶

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

`UserLeveling`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional
`totalXp`	`integer`	Optional
`dailyXpLeft`	`integer`	Optional
`availableSkillPoints`	`integer`	Optional
`spentSkillPoints`	`integer`	Optional
`totalSkillPoints`	`integer`	Optional
`freeReset`	`integer`	Optional

`UserLite`¶

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

`UserRankings`¶

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

`UserSkills`¶

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

`UserStats`¶

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

`UserStatsCase1`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional
`openedCount`	`integer`	Optional

`UserStatsCase1ByRarity`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`common`	`integer`	Optional
`uncommon`	`integer`	Optional
`rare`	`integer`	Optional
`epic`	`integer`	Optional
`legendary`	`integer`	Optional

`UserStatsWealth`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`companies`	`number`	Optional
`items`	`number`	Optional
`money`	`number`	Optional
`equipments`	`number`	Optional
`weapons`	`number`	Optional
`total`	`number`	Optional

`.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`	`None`
`time_slice_days`	`int`	`30`
`concurrency`	`int`	`500`
`kwargs`	`Any`	Required

Return Models¶

`RankingDetail`¶

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

`SkillDetail`¶

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

`UserDates`¶

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

`UserInfos`¶

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

`UserLeveling`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional
`totalXp`	`integer`	Optional
`dailyXpLeft`	`integer`	Optional
`availableSkillPoints`	`integer`	Optional
`spentSkillPoints`	`integer`	Optional
`totalSkillPoints`	`integer`	Optional
`freeReset`	`integer`	Optional

`UserLite`¶

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

`UserRankings`¶

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

`UserSkills`¶

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

`UserStats`¶

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

`UserStatsCase1`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional
`openedCount`	`integer`	Optional

`UserStatsCase1ByRarity`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`common`	`integer`	Optional
`uncommon`	`integer`	Optional
`rare`	`integer`	Optional
`epic`	`integer`	Optional
`legendary`	`integer`	Optional

`UserStatsWealth`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`companies`	`number`	Optional
`items`	`number`	Optional
`money`	`number`	Optional
`equipments`	`number`	Optional
`weapons`	`number`	Optional
`total`	`number`	Optional

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

Return Models¶

`CursorPage[UserLite]`¶

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

`RankingDetail`¶

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

`SkillDetail`¶

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

`UserDates`¶

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

`UserInfos`¶

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

`UserLeveling`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional
`totalXp`	`integer`	Optional
`dailyXpLeft`	`integer`	Optional
`availableSkillPoints`	`integer`	Optional
`spentSkillPoints`	`integer`	Optional
`totalSkillPoints`	`integer`	Optional
`freeReset`	`integer`	Optional

`UserLite`¶

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

`UserRankings`¶

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

`UserSkills`¶

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

`UserStats`¶

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

`UserStatsCase1`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional
`openedCount`	`integer`	Optional

`UserStatsCase1ByRarity`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`common`	`integer`	Optional
`uncommon`	`integer`	Optional
`rare`	`integer`	Optional
`epic`	`integer`	Optional
`legendary`	`integer`	Optional

`UserStatsWealth`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`companies`	`number`	Optional
`items`	`number`	Optional
`money`	`number`	Optional
`equipments`	`number`	Optional
`weapons`	`number`	Optional
`total`	`number`	Optional

`.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
`_id`	`string`	Optional
`__v`	`integer`	Optional
`value`	`number`	Optional
`rank`	`integer`	Optional
`tier`	`string`	Optional
`country`	`string`	Optional

`SkillDetail`¶

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

`User`¶

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

`UserDates`¶

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

`UserEquipment`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`ammo`	`string`	Optional
`helmet`	`string`	Optional
`chest`	`string`	Optional
`boots`	`string`	Optional
`pants`	`string`	Optional
`gloves`	`string`	Optional
`weapon`	`string`	Optional

`UserInfos`¶

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

`UserLeveling`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional
`totalXp`	`integer`	Optional
`dailyXpLeft`	`integer`	Optional
`availableSkillPoints`	`integer`	Optional
`spentSkillPoints`	`integer`	Optional
`totalSkillPoints`	`integer`	Optional
`freeReset`	`integer`	Optional

`UserMissions`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`claimedAt`	`UserMissionsClaimedAt`	Optional
`rerolledDailyMissions`	`integer`	Optional
`rerolledWeeklyMissions`	`integer`	Optional

`UserMissionsClaimedAt`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`starting`	`string`	Optional
`daily`	`string`	Optional
`weekly`	`string`	Optional
`monthly`	`string`	Optional

`UserPreferences`¶

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

`UserRankings`¶

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

`UserSkills`¶

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

`UserStats`¶

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

`UserStatsCase1`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional
`openedCount`	`integer`	Optional

`UserStatsCase1ByRarity`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`common`	`integer`	Optional
`uncommon`	`integer`	Optional
`rare`	`integer`	Optional
`epic`	`integer`	Optional
`legendary`	`integer`	Optional

`UserStatsWealth`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`companies`	`number`	Optional
`items`	`number`	Optional
`money`	`number`	Optional
`equipments`	`number`	Optional
`weapons`	`number`	Optional
`total`	`number`	Optional

`.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
`_id`	`string`	Optional
`__v`	`integer`	Optional
`value`	`number`	Optional
`rank`	`integer`	Optional
`tier`	`string`	Optional
`country`	`string`	Optional

`SkillDetail`¶

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

`UserDates`¶

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

`UserInfos`¶

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

`UserLeveling`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional
`totalXp`	`integer`	Optional
`dailyXpLeft`	`integer`	Optional
`availableSkillPoints`	`integer`	Optional
`spentSkillPoints`	`integer`	Optional
`totalSkillPoints`	`integer`	Optional
`freeReset`	`integer`	Optional

`UserLite`¶

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

`UserRankings`¶

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

`UserSkills`¶

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

`UserStats`¶

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

`UserStatsCase1`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional
`openedCount`	`integer`	Optional

`UserStatsCase1ByRarity`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`common`	`integer`	Optional
`uncommon`	`integer`	Optional
`rare`	`integer`	Optional
`epic`	`integer`	Optional
`legendary`	`integer`	Optional

`UserStatsWealth`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`companies`	`number`	Optional
`items`	`number`	Optional
`money`	`number`	Optional
`equipments`	`number`	Optional
`weapons`	`number`	Optional
`total`	`number`	Optional

`.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
`_id`	`string`	Optional
`__v`	`integer`	Optional
`value`	`number`	Optional
`rank`	`integer`	Optional
`tier`	`string`	Optional
`country`	`string`	Optional

`SkillDetail`¶

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

`User`¶

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

`UserDates`¶

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

`UserEquipment`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`ammo`	`string`	Optional
`helmet`	`string`	Optional
`chest`	`string`	Optional
`boots`	`string`	Optional
`pants`	`string`	Optional
`gloves`	`string`	Optional
`weapon`	`string`	Optional

`UserInfos`¶

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

`UserLeveling`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional
`totalXp`	`integer`	Optional
`dailyXpLeft`	`integer`	Optional
`availableSkillPoints`	`integer`	Optional
`spentSkillPoints`	`integer`	Optional
`totalSkillPoints`	`integer`	Optional
`freeReset`	`integer`	Optional

`UserMissions`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`claimedAt`	`UserMissionsClaimedAt`	Optional
`rerolledDailyMissions`	`integer`	Optional
`rerolledWeeklyMissions`	`integer`	Optional

`UserMissionsClaimedAt`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`starting`	`string`	Optional
`daily`	`string`	Optional
`weekly`	`string`	Optional
`monthly`	`string`	Optional

`UserPreferences`¶

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

`UserRankings`¶

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

`UserSkills`¶

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

`UserStats`¶

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

`UserStatsCase1`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional
`openedCount`	`integer`	Optional

`UserStatsCase1ByRarity`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`common`	`integer`	Optional
`uncommon`	`integer`	Optional
`rare`	`integer`	Optional
`epic`	`integer`	Optional
`legendary`	`integer`	Optional

`UserStatsWealth`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`companies`	`number`	Optional
`items`	`number`	Optional
`money`	`number`	Optional
`equipments`	`number`	Optional
`weapons`	`number`	Optional
`total`	`number`	Optional

`.get_users_by_country()`¶

Get users by country.

Signature¶

await client.user.get_users_by_country(country_id: 'str') -> 'list[User]'

Parameters¶

Name	Type	Default
`country_id`	`str`	Required

Return Models¶

`RankingDetail`¶

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

`SkillDetail`¶

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

`User`¶

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

`UserDates`¶

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

`UserEquipment`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`ammo`	`string`	Optional
`helmet`	`string`	Optional
`chest`	`string`	Optional
`boots`	`string`	Optional
`pants`	`string`	Optional
`gloves`	`string`	Optional
`weapon`	`string`	Optional

`UserInfos`¶

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

`UserLeveling`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional
`totalXp`	`integer`	Optional
`dailyXpLeft`	`integer`	Optional
`availableSkillPoints`	`integer`	Optional
`spentSkillPoints`	`integer`	Optional
`totalSkillPoints`	`integer`	Optional
`freeReset`	`integer`	Optional

`UserMissions`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`claimedAt`	`UserMissionsClaimedAt`	Optional
`rerolledDailyMissions`	`integer`	Optional
`rerolledWeeklyMissions`	`integer`	Optional

`UserMissionsClaimedAt`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`starting`	`string`	Optional
`daily`	`string`	Optional
`weekly`	`string`	Optional
`monthly`	`string`	Optional

`UserPreferences`¶

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

`UserRankings`¶

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

`UserSkills`¶

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

`UserStats`¶

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

`UserStatsCase1`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional
`openedCount`	`integer`	Optional

`UserStatsCase1ByRarity`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`common`	`integer`	Optional
`uncommon`	`integer`	Optional
`rare`	`integer`	Optional
`epic`	`integer`	Optional
`legendary`	`integer`	Optional

`UserStatsWealth`¶

Field	Type	Required
`_id`	`string`	Optional
`__v`	`integer`	Optional
`companies`	`number`	Optional
`items`	`number`	Optional
`money`	`number`	Optional
`equipments`	`number`	Optional
`weapons`	`number`	Optional
`total`	`number`	Optional

`.invalidate_cache()`¶

Clear the SWR cache for all resources.

Signature¶

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

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¶

UserLeveling¶

UserLite¶

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`¶