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`	Optional
`__v`	`integer`	Optional
`value`	`number`	Optional	The value.
`rank`	`integer`	Optional	The rank.
`tier`	`string`	Optional	The tier.
`country`	`string`	Optional	The UUID of the country this user holds citizenship in.

`SkillDetail`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional	The current overall level of the entity.
`currentBarValue`	`number`	Optional	The current bar value.
`value`	`number`	Optional	The value.
`weapon`	`number`	Optional	The weapon.
`equipment`	`number`	Optional	The equipment.
`limited`	`number`	Optional	The limited.
`total`	`number`	Optional	The total.
`hourlyBarRegen`	`number`	Optional	The hourly bar regen.
`totalAfterSoftCap`	`number`	Optional	The total after soft cap.
`overflow`	`number`	Optional	The overflow.
`ammoPercent`	`number`	Optional	The ammo percent.
`buffsPercent`	`number`	Optional	The buffs percent.
`debuffsPercent`	`number`	Optional	The debuffs percent.
`militaryRankPercent`	`number`	Optional	The military rank percent.

`UserDates`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`lastConnectionAt`	`string`	Optional	The timestamp of the user's last login.
`lastTakingControlAt`	`string`	Optional	The timestamp of the last taking control event.
`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	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`colorScheme`	`string`	Optional	The color scheme.
`description`	`string`	Optional	The description.
`font`	`string`	Optional	The font.
`isPremium`	`boolean`	Optional	The is premium.
`premiumGiftsCount`	`integer`	Optional	The total number of premium gifts.
`premiumMonthsCount`	`integer`	Optional	The total number of premium months.
`vicePresidentOf`	`string`	Optional	The vice president of.

`UserLeveling`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional	The current overall level of the entity.
`totalXp`	`integer`	Optional	The total lifetime experience points accumulated.
`dailyXpLeft`	`integer`	Optional	The remaining experience points the user can earn today before hitting the daily cap.
`availableSkillPoints`	`integer`	Optional	Unspent skill points awarded from leveling up.
`spentSkillPoints`	`integer`	Optional	The spent skill points.
`totalSkillPoints`	`integer`	Optional	The total skill points.
`freeReset`	`integer`	Optional	The free reset.

`UserLite`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`username`	`string`	Optional	The unique display name of the user.
`usernameLower`	`string`	Optional	The lowercase version of the username used for case-insensitive indexing.
`canOnboard`	`boolean`	Optional	Whether the user is a new player eligible for the onboarding tutorial.
`country`	`string`	Optional	The UUID of the country this user holds citizenship in.
`isActive`	`boolean`	Optional	Whether the user has logged in recently and is considered an active player.
`avatarUrl`	`string`	Optional	The CDN URL pointing to the user's profile picture.
`mu`	`string`	Optional	The UUID of the Military Unit this user belongs to.
`militaryRank`	`integer`	Optional	The total military rank points indicating the user's overall combat experience.
`createdAt`	`string`	Optional	The timestamp when this record was created.
`updatedAt`	`string`	Optional	The timestamp when this record was last modified.
`emailVerified`	`boolean`	Optional	Whether the user has verified their email address to unlock trading and chat.
`dates`	`UserDates`	Optional	The dates.
`leveling`	`UserLeveling`	Optional	The leveling.
`stats`	`UserStats`	Optional	The stats.
`rankings`	`UserRankings`	Optional	The country's current standing in the global leaderboards.
`infos`	`UserInfos`	Optional	The infos.
`skills`	`UserSkills`	Optional	The skills.
`equippedSkinKeys`	`object`	Optional	The equipped skin keys.

`UserRankings`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`userDamages`	`RankingDetail`	Optional	The user damages.
`weeklyUserDamages`	`RankingDetail`	Optional	The weekly user damages.
`userWealth`	`RankingDetail`	Optional	The user wealth.
`userLevel`	`RankingDetail`	Optional	The user level.
`userReferrals`	`RankingDetail`	Optional	The user referrals.
`userTerrain`	`RankingDetail`	Optional	The user terrain.
`userCasesOpened`	`RankingDetail`	Optional	The user cases opened.
`userBounty`	`RankingDetail`	Optional	The user bounty.
`userGemsPurchased`	`RankingDetail`	Optional	The user gems purchased.
`userPremiumGifts`	`RankingDetail`	Optional	The user premium gifts.
`userPremiumMonths`	`RankingDetail`	Optional	The user premium months.
`userSubscribers`	`RankingDetail`	Optional	The user subscribers.

`UserSkills`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`energy`	`SkillDetail`	Optional	The energy.
`health`	`SkillDetail`	Optional	The health.
`hunger`	`SkillDetail`	Optional	The hunger.
`attack`	`SkillDetail`	Optional	The attack.
`companies`	`SkillDetail`	Optional	The companies.
`entrepreneurship`	`SkillDetail`	Optional	The entrepreneurship.
`production`	`SkillDetail`	Optional	The production.
`criticalChance`	`SkillDetail`	Optional	The critical chance.
`criticalDamages`	`SkillDetail`	Optional	The critical damages.
`armor`	`SkillDetail`	Optional	The armor.
`precision`	`SkillDetail`	Optional	The precision.
`dodge`	`SkillDetail`	Optional	The dodge.
`lootChance`	`SkillDetail`	Optional	The loot chance.
`management`	`SkillDetail`	Optional	The management.

`UserStats`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`estimatedCompanyValues`	`number`	Optional	The estimated company values.
`estimatedInventoryValue`	`number`	Optional	The estimated inventory value.
`estimatedWealth`	`number`	Optional	The estimated wealth.
`worksCount`	`integer`	Optional	The total number of works.
`damagesCount`	`integer`	Optional	The total number of damages.
`wealth`	`UserStatsWealth`	Optional	The wealth.
`case1`	`UserStatsCase1`	Optional	The case1.

`UserStatsCase1`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional	The by rarity.
`openedCount`	`integer`	Optional	The total number of opened.

`UserStatsCase1ByRarity`

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

`UserStatsWealth`

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

`.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	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`value`	`number`	Optional	The value.
`rank`	`integer`	Optional	The rank.
`tier`	`string`	Optional	The tier.
`country`	`string`	Optional	The UUID of the country this user holds citizenship in.

`SkillDetail`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional	The current overall level of the entity.
`currentBarValue`	`number`	Optional	The current bar value.
`value`	`number`	Optional	The value.
`weapon`	`number`	Optional	The weapon.
`equipment`	`number`	Optional	The equipment.
`limited`	`number`	Optional	The limited.
`total`	`number`	Optional	The total.
`hourlyBarRegen`	`number`	Optional	The hourly bar regen.
`totalAfterSoftCap`	`number`	Optional	The total after soft cap.
`overflow`	`number`	Optional	The overflow.
`ammoPercent`	`number`	Optional	The ammo percent.
`buffsPercent`	`number`	Optional	The buffs percent.
`debuffsPercent`	`number`	Optional	The debuffs percent.
`militaryRankPercent`	`number`	Optional	The military rank percent.

`UserDates`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`lastConnectionAt`	`string`	Optional	The timestamp of the user's last login.
`lastTakingControlAt`	`string`	Optional	The timestamp of the last taking control event.
`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	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`colorScheme`	`string`	Optional	The color scheme.
`description`	`string`	Optional	The description.
`font`	`string`	Optional	The font.
`isPremium`	`boolean`	Optional	The is premium.
`premiumGiftsCount`	`integer`	Optional	The total number of premium gifts.
`premiumMonthsCount`	`integer`	Optional	The total number of premium months.
`vicePresidentOf`	`string`	Optional	The vice president of.

`UserLeveling`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional	The current overall level of the entity.
`totalXp`	`integer`	Optional	The total lifetime experience points accumulated.
`dailyXpLeft`	`integer`	Optional	The remaining experience points the user can earn today before hitting the daily cap.
`availableSkillPoints`	`integer`	Optional	Unspent skill points awarded from leveling up.
`spentSkillPoints`	`integer`	Optional	The spent skill points.
`totalSkillPoints`	`integer`	Optional	The total skill points.
`freeReset`	`integer`	Optional	The free reset.

`UserLite`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`username`	`string`	Optional	The unique display name of the user.
`usernameLower`	`string`	Optional	The lowercase version of the username used for case-insensitive indexing.
`canOnboard`	`boolean`	Optional	Whether the user is a new player eligible for the onboarding tutorial.
`country`	`string`	Optional	The UUID of the country this user holds citizenship in.
`isActive`	`boolean`	Optional	Whether the user has logged in recently and is considered an active player.
`avatarUrl`	`string`	Optional	The CDN URL pointing to the user's profile picture.
`mu`	`string`	Optional	The UUID of the Military Unit this user belongs to.
`militaryRank`	`integer`	Optional	The total military rank points indicating the user's overall combat experience.
`createdAt`	`string`	Optional	The timestamp when this record was created.
`updatedAt`	`string`	Optional	The timestamp when this record was last modified.
`emailVerified`	`boolean`	Optional	Whether the user has verified their email address to unlock trading and chat.
`dates`	`UserDates`	Optional	The dates.
`leveling`	`UserLeveling`	Optional	The leveling.
`stats`	`UserStats`	Optional	The stats.
`rankings`	`UserRankings`	Optional	The country's current standing in the global leaderboards.
`infos`	`UserInfos`	Optional	The infos.
`skills`	`UserSkills`	Optional	The skills.
`equippedSkinKeys`	`object`	Optional	The equipped skin keys.

`UserRankings`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`userDamages`	`RankingDetail`	Optional	The user damages.
`weeklyUserDamages`	`RankingDetail`	Optional	The weekly user damages.
`userWealth`	`RankingDetail`	Optional	The user wealth.
`userLevel`	`RankingDetail`	Optional	The user level.
`userReferrals`	`RankingDetail`	Optional	The user referrals.
`userTerrain`	`RankingDetail`	Optional	The user terrain.
`userCasesOpened`	`RankingDetail`	Optional	The user cases opened.
`userBounty`	`RankingDetail`	Optional	The user bounty.
`userGemsPurchased`	`RankingDetail`	Optional	The user gems purchased.
`userPremiumGifts`	`RankingDetail`	Optional	The user premium gifts.
`userPremiumMonths`	`RankingDetail`	Optional	The user premium months.
`userSubscribers`	`RankingDetail`	Optional	The user subscribers.

`UserSkills`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`energy`	`SkillDetail`	Optional	The energy.
`health`	`SkillDetail`	Optional	The health.
`hunger`	`SkillDetail`	Optional	The hunger.
`attack`	`SkillDetail`	Optional	The attack.
`companies`	`SkillDetail`	Optional	The companies.
`entrepreneurship`	`SkillDetail`	Optional	The entrepreneurship.
`production`	`SkillDetail`	Optional	The production.
`criticalChance`	`SkillDetail`	Optional	The critical chance.
`criticalDamages`	`SkillDetail`	Optional	The critical damages.
`armor`	`SkillDetail`	Optional	The armor.
`precision`	`SkillDetail`	Optional	The precision.
`dodge`	`SkillDetail`	Optional	The dodge.
`lootChance`	`SkillDetail`	Optional	The loot chance.
`management`	`SkillDetail`	Optional	The management.

`UserStats`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`estimatedCompanyValues`	`number`	Optional	The estimated company values.
`estimatedInventoryValue`	`number`	Optional	The estimated inventory value.
`estimatedWealth`	`number`	Optional	The estimated wealth.
`worksCount`	`integer`	Optional	The total number of works.
`damagesCount`	`integer`	Optional	The total number of damages.
`wealth`	`UserStatsWealth`	Optional	The wealth.
`case1`	`UserStatsCase1`	Optional	The case1.

`UserStatsCase1`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional	The by rarity.
`openedCount`	`integer`	Optional	The total number of opened.

`UserStatsCase1ByRarity`

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

`UserStatsWealth`

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

`.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	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`value`	`number`	Optional	The value.
`rank`	`integer`	Optional	The rank.
`tier`	`string`	Optional	The tier.
`country`	`string`	Optional	The UUID of the country this user holds citizenship in.

`SkillDetail`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional	The current overall level of the entity.
`currentBarValue`	`number`	Optional	The current bar value.
`value`	`number`	Optional	The value.
`weapon`	`number`	Optional	The weapon.
`equipment`	`number`	Optional	The equipment.
`limited`	`number`	Optional	The limited.
`total`	`number`	Optional	The total.
`hourlyBarRegen`	`number`	Optional	The hourly bar regen.
`totalAfterSoftCap`	`number`	Optional	The total after soft cap.
`overflow`	`number`	Optional	The overflow.
`ammoPercent`	`number`	Optional	The ammo percent.
`buffsPercent`	`number`	Optional	The buffs percent.
`debuffsPercent`	`number`	Optional	The debuffs percent.
`militaryRankPercent`	`number`	Optional	The military rank percent.

`UserDates`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`lastConnectionAt`	`string`	Optional	The timestamp of the user's last login.
`lastTakingControlAt`	`string`	Optional	The timestamp of the last taking control event.
`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	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`colorScheme`	`string`	Optional	The color scheme.
`description`	`string`	Optional	The description.
`font`	`string`	Optional	The font.
`isPremium`	`boolean`	Optional	The is premium.
`premiumGiftsCount`	`integer`	Optional	The total number of premium gifts.
`premiumMonthsCount`	`integer`	Optional	The total number of premium months.
`vicePresidentOf`	`string`	Optional	The vice president of.

`UserLeveling`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional	The current overall level of the entity.
`totalXp`	`integer`	Optional	The total lifetime experience points accumulated.
`dailyXpLeft`	`integer`	Optional	The remaining experience points the user can earn today before hitting the daily cap.
`availableSkillPoints`	`integer`	Optional	Unspent skill points awarded from leveling up.
`spentSkillPoints`	`integer`	Optional	The spent skill points.
`totalSkillPoints`	`integer`	Optional	The total skill points.
`freeReset`	`integer`	Optional	The free reset.

`UserLite`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`username`	`string`	Optional	The unique display name of the user.
`usernameLower`	`string`	Optional	The lowercase version of the username used for case-insensitive indexing.
`canOnboard`	`boolean`	Optional	Whether the user is a new player eligible for the onboarding tutorial.
`country`	`string`	Optional	The UUID of the country this user holds citizenship in.
`isActive`	`boolean`	Optional	Whether the user has logged in recently and is considered an active player.
`avatarUrl`	`string`	Optional	The CDN URL pointing to the user's profile picture.
`mu`	`string`	Optional	The UUID of the Military Unit this user belongs to.
`militaryRank`	`integer`	Optional	The total military rank points indicating the user's overall combat experience.
`createdAt`	`string`	Optional	The timestamp when this record was created.
`updatedAt`	`string`	Optional	The timestamp when this record was last modified.
`emailVerified`	`boolean`	Optional	Whether the user has verified their email address to unlock trading and chat.
`dates`	`UserDates`	Optional	The dates.
`leveling`	`UserLeveling`	Optional	The leveling.
`stats`	`UserStats`	Optional	The stats.
`rankings`	`UserRankings`	Optional	The country's current standing in the global leaderboards.
`infos`	`UserInfos`	Optional	The infos.
`skills`	`UserSkills`	Optional	The skills.
`equippedSkinKeys`	`object`	Optional	The equipped skin keys.

`UserRankings`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`userDamages`	`RankingDetail`	Optional	The user damages.
`weeklyUserDamages`	`RankingDetail`	Optional	The weekly user damages.
`userWealth`	`RankingDetail`	Optional	The user wealth.
`userLevel`	`RankingDetail`	Optional	The user level.
`userReferrals`	`RankingDetail`	Optional	The user referrals.
`userTerrain`	`RankingDetail`	Optional	The user terrain.
`userCasesOpened`	`RankingDetail`	Optional	The user cases opened.
`userBounty`	`RankingDetail`	Optional	The user bounty.
`userGemsPurchased`	`RankingDetail`	Optional	The user gems purchased.
`userPremiumGifts`	`RankingDetail`	Optional	The user premium gifts.
`userPremiumMonths`	`RankingDetail`	Optional	The user premium months.
`userSubscribers`	`RankingDetail`	Optional	The user subscribers.

`UserSkills`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`energy`	`SkillDetail`	Optional	The energy.
`health`	`SkillDetail`	Optional	The health.
`hunger`	`SkillDetail`	Optional	The hunger.
`attack`	`SkillDetail`	Optional	The attack.
`companies`	`SkillDetail`	Optional	The companies.
`entrepreneurship`	`SkillDetail`	Optional	The entrepreneurship.
`production`	`SkillDetail`	Optional	The production.
`criticalChance`	`SkillDetail`	Optional	The critical chance.
`criticalDamages`	`SkillDetail`	Optional	The critical damages.
`armor`	`SkillDetail`	Optional	The armor.
`precision`	`SkillDetail`	Optional	The precision.
`dodge`	`SkillDetail`	Optional	The dodge.
`lootChance`	`SkillDetail`	Optional	The loot chance.
`management`	`SkillDetail`	Optional	The management.

`UserStats`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`estimatedCompanyValues`	`number`	Optional	The estimated company values.
`estimatedInventoryValue`	`number`	Optional	The estimated inventory value.
`estimatedWealth`	`number`	Optional	The estimated wealth.
`worksCount`	`integer`	Optional	The total number of works.
`damagesCount`	`integer`	Optional	The total number of damages.
`wealth`	`UserStatsWealth`	Optional	The wealth.
`case1`	`UserStatsCase1`	Optional	The case1.

`UserStatsCase1`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional	The by rarity.
`openedCount`	`integer`	Optional	The total number of opened.

`UserStatsCase1ByRarity`

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

`UserStatsWealth`

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

`.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`	Optional
`__v`	`integer`	Optional
`value`	`number`	Optional	The value.
`rank`	`integer`	Optional	The rank.
`tier`	`string`	Optional	The tier.
`country`	`string`	Optional	The UUID of the country this user holds citizenship in.

`SkillDetail`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional	The current overall level of the entity.
`currentBarValue`	`number`	Optional	The current bar value.
`value`	`number`	Optional	The value.
`weapon`	`number`	Optional	The weapon.
`equipment`	`number`	Optional	The equipment.
`limited`	`number`	Optional	The limited.
`total`	`number`	Optional	The total.
`hourlyBarRegen`	`number`	Optional	The hourly bar regen.
`totalAfterSoftCap`	`number`	Optional	The total after soft cap.
`overflow`	`number`	Optional	The overflow.
`ammoPercent`	`number`	Optional	The ammo percent.
`buffsPercent`	`number`	Optional	The buffs percent.
`debuffsPercent`	`number`	Optional	The debuffs percent.
`militaryRankPercent`	`number`	Optional	The military rank percent.

`User`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`username`	`string`	Optional	The unique display name of the user.
`usernameLower`	`string`	Optional	The lowercase version of the username used for case-insensitive indexing.
`canOnboard`	`boolean`	Optional	Whether the user is a new player eligible for the onboarding tutorial.
`country`	`string`	Optional	The UUID of the country this user holds citizenship in.
`isActive`	`boolean`	Optional	Whether the user has logged in recently and is considered an active player.
`avatarUrl`	`string`	Optional	The CDN URL pointing to the user's profile picture.
`mu`	`string`	Optional	The UUID of the Military Unit this user belongs to.
`militaryRank`	`integer`	Optional	The total military rank points indicating the user's overall combat experience.
`createdAt`	`string`	Optional	The timestamp when this record was created.
`updatedAt`	`string`	Optional	The timestamp when this record was last modified.
`emailVerified`	`boolean`	Optional	Whether the user has verified their email address to unlock trading and chat.
`dates`	`UserDates`	Optional
`leveling`	`UserLeveling`	Optional	The leveling.
`stats`	`UserStats`	Optional	The stats.
`rankings`	`UserRankings`	Optional	The country's current standing in the global leaderboards.
`infos`	`UserInfos`	Optional	The infos.
`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	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`lastConnectionAt`	`string`	Optional	The timestamp of the user's last login.
`lastTakingControlAt`	`string`	Optional	The timestamp of the last taking control event.
`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	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`ammo`	`string`	Optional	The ammo.
`helmet`	`string`	Optional	The helmet.
`chest`	`string`	Optional	The chest.
`boots`	`string`	Optional	The boots.
`pants`	`string`	Optional	The pants.
`gloves`	`string`	Optional	The gloves.
`weapon`	`string`	Optional	The weapon.

`UserInfos`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`colorScheme`	`string`	Optional	The color scheme.
`description`	`string`	Optional	The description.
`font`	`string`	Optional	The font.
`isPremium`	`boolean`	Optional	The is premium.
`premiumGiftsCount`	`integer`	Optional	The total number of premium gifts.
`premiumMonthsCount`	`integer`	Optional	The total number of premium months.
`vicePresidentOf`	`string`	Optional	The vice president of.

`UserLeveling`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional	The current overall level of the entity.
`totalXp`	`integer`	Optional	The total lifetime experience points accumulated.
`dailyXpLeft`	`integer`	Optional	The remaining experience points the user can earn today before hitting the daily cap.
`availableSkillPoints`	`integer`	Optional	Unspent skill points awarded from leveling up.
`spentSkillPoints`	`integer`	Optional	The spent skill points.
`totalSkillPoints`	`integer`	Optional	The total skill points.
`freeReset`	`integer`	Optional	The free reset.

`UserMissions`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`claimedAt`	`UserMissionsClaimedAt`	Optional	The claimed at.
`rerolledDailyMissions`	`integer`	Optional	The rerolled daily missions.
`rerolledWeeklyMissions`	`integer`	Optional	The rerolled weekly missions.

`UserMissionsClaimedAt`

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

`UserPreferences`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`autoReplaceOnBreak`	`boolean`	Optional	The auto replace on break.
`autoEquipMode`	`string`	Optional	The auto equip mode.
`appFont`	`string`	Optional	The app font.
`appPattern`	`string`	Optional	The app pattern.
`locale`	`string`	Optional	The locale.
`sfx`	`boolean`	Optional	The sfx.
`colorblind`	`boolean`	Optional	The colorblind.

`UserRankings`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`userDamages`	`RankingDetail`	Optional	The user damages.
`weeklyUserDamages`	`RankingDetail`	Optional	The weekly user damages.
`userWealth`	`RankingDetail`	Optional	The user wealth.
`userLevel`	`RankingDetail`	Optional	The user level.
`userReferrals`	`RankingDetail`	Optional	The user referrals.
`userTerrain`	`RankingDetail`	Optional	The user terrain.
`userCasesOpened`	`RankingDetail`	Optional	The user cases opened.
`userBounty`	`RankingDetail`	Optional	The user bounty.
`userGemsPurchased`	`RankingDetail`	Optional	The user gems purchased.
`userPremiumGifts`	`RankingDetail`	Optional	The user premium gifts.
`userPremiumMonths`	`RankingDetail`	Optional	The user premium months.
`userSubscribers`	`RankingDetail`	Optional	The user subscribers.

`UserSkills`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`energy`	`SkillDetail`	Optional	The energy.
`health`	`SkillDetail`	Optional	The health.
`hunger`	`SkillDetail`	Optional	The hunger.
`attack`	`SkillDetail`	Optional	The attack.
`companies`	`SkillDetail`	Optional	The companies.
`entrepreneurship`	`SkillDetail`	Optional	The entrepreneurship.
`production`	`SkillDetail`	Optional	The production.
`criticalChance`	`SkillDetail`	Optional	The critical chance.
`criticalDamages`	`SkillDetail`	Optional	The critical damages.
`armor`	`SkillDetail`	Optional	The armor.
`precision`	`SkillDetail`	Optional	The precision.
`dodge`	`SkillDetail`	Optional	The dodge.
`lootChance`	`SkillDetail`	Optional	The loot chance.
`management`	`SkillDetail`	Optional	The management.

`UserStats`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`estimatedCompanyValues`	`number`	Optional	The estimated company values.
`estimatedInventoryValue`	`number`	Optional	The estimated inventory value.
`estimatedWealth`	`number`	Optional	The estimated wealth.
`worksCount`	`integer`	Optional	The total number of works.
`damagesCount`	`integer`	Optional	The total number of damages.
`wealth`	`UserStatsWealth`	Optional	The wealth.
`case1`	`UserStatsCase1`	Optional	The case1.

`UserStatsCase1`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional	The by rarity.
`openedCount`	`integer`	Optional	The total number of opened.

`UserStatsCase1ByRarity`

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

`UserStatsWealth`

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

`.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`	Optional
`__v`	`integer`	Optional
`value`	`number`	Optional	The value.
`rank`	`integer`	Optional	The rank.
`tier`	`string`	Optional	The tier.
`country`	`string`	Optional	The UUID of the country this user holds citizenship in.

`SkillDetail`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional	The current overall level of the entity.
`currentBarValue`	`number`	Optional	The current bar value.
`value`	`number`	Optional	The value.
`weapon`	`number`	Optional	The weapon.
`equipment`	`number`	Optional	The equipment.
`limited`	`number`	Optional	The limited.
`total`	`number`	Optional	The total.
`hourlyBarRegen`	`number`	Optional	The hourly bar regen.
`totalAfterSoftCap`	`number`	Optional	The total after soft cap.
`overflow`	`number`	Optional	The overflow.
`ammoPercent`	`number`	Optional	The ammo percent.
`buffsPercent`	`number`	Optional	The buffs percent.
`debuffsPercent`	`number`	Optional	The debuffs percent.
`militaryRankPercent`	`number`	Optional	The military rank percent.

`UserDates`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`lastConnectionAt`	`string`	Optional	The timestamp of the user's last login.
`lastTakingControlAt`	`string`	Optional	The timestamp of the last taking control event.
`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	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`colorScheme`	`string`	Optional	The color scheme.
`description`	`string`	Optional	The description.
`font`	`string`	Optional	The font.
`isPremium`	`boolean`	Optional	The is premium.
`premiumGiftsCount`	`integer`	Optional	The total number of premium gifts.
`premiumMonthsCount`	`integer`	Optional	The total number of premium months.
`vicePresidentOf`	`string`	Optional	The vice president of.

`UserLeveling`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional	The current overall level of the entity.
`totalXp`	`integer`	Optional	The total lifetime experience points accumulated.
`dailyXpLeft`	`integer`	Optional	The remaining experience points the user can earn today before hitting the daily cap.
`availableSkillPoints`	`integer`	Optional	Unspent skill points awarded from leveling up.
`spentSkillPoints`	`integer`	Optional	The spent skill points.
`totalSkillPoints`	`integer`	Optional	The total skill points.
`freeReset`	`integer`	Optional	The free reset.

`UserLite`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`username`	`string`	Optional	The unique display name of the user.
`usernameLower`	`string`	Optional	The lowercase version of the username used for case-insensitive indexing.
`canOnboard`	`boolean`	Optional	Whether the user is a new player eligible for the onboarding tutorial.
`country`	`string`	Optional	The UUID of the country this user holds citizenship in.
`isActive`	`boolean`	Optional	Whether the user has logged in recently and is considered an active player.
`avatarUrl`	`string`	Optional	The CDN URL pointing to the user's profile picture.
`mu`	`string`	Optional	The UUID of the Military Unit this user belongs to.
`militaryRank`	`integer`	Optional	The total military rank points indicating the user's overall combat experience.
`createdAt`	`string`	Optional	The timestamp when this record was created.
`updatedAt`	`string`	Optional	The timestamp when this record was last modified.
`emailVerified`	`boolean`	Optional	Whether the user has verified their email address to unlock trading and chat.
`dates`	`UserDates`	Optional	The dates.
`leveling`	`UserLeveling`	Optional	The leveling.
`stats`	`UserStats`	Optional	The stats.
`rankings`	`UserRankings`	Optional	The country's current standing in the global leaderboards.
`infos`	`UserInfos`	Optional	The infos.
`skills`	`UserSkills`	Optional	The skills.
`equippedSkinKeys`	`object`	Optional	The equipped skin keys.

`UserRankings`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`userDamages`	`RankingDetail`	Optional	The user damages.
`weeklyUserDamages`	`RankingDetail`	Optional	The weekly user damages.
`userWealth`	`RankingDetail`	Optional	The user wealth.
`userLevel`	`RankingDetail`	Optional	The user level.
`userReferrals`	`RankingDetail`	Optional	The user referrals.
`userTerrain`	`RankingDetail`	Optional	The user terrain.
`userCasesOpened`	`RankingDetail`	Optional	The user cases opened.
`userBounty`	`RankingDetail`	Optional	The user bounty.
`userGemsPurchased`	`RankingDetail`	Optional	The user gems purchased.
`userPremiumGifts`	`RankingDetail`	Optional	The user premium gifts.
`userPremiumMonths`	`RankingDetail`	Optional	The user premium months.
`userSubscribers`	`RankingDetail`	Optional	The user subscribers.

`UserSkills`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`energy`	`SkillDetail`	Optional	The energy.
`health`	`SkillDetail`	Optional	The health.
`hunger`	`SkillDetail`	Optional	The hunger.
`attack`	`SkillDetail`	Optional	The attack.
`companies`	`SkillDetail`	Optional	The companies.
`entrepreneurship`	`SkillDetail`	Optional	The entrepreneurship.
`production`	`SkillDetail`	Optional	The production.
`criticalChance`	`SkillDetail`	Optional	The critical chance.
`criticalDamages`	`SkillDetail`	Optional	The critical damages.
`armor`	`SkillDetail`	Optional	The armor.
`precision`	`SkillDetail`	Optional	The precision.
`dodge`	`SkillDetail`	Optional	The dodge.
`lootChance`	`SkillDetail`	Optional	The loot chance.
`management`	`SkillDetail`	Optional	The management.

`UserStats`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`estimatedCompanyValues`	`number`	Optional	The estimated company values.
`estimatedInventoryValue`	`number`	Optional	The estimated inventory value.
`estimatedWealth`	`number`	Optional	The estimated wealth.
`worksCount`	`integer`	Optional	The total number of works.
`damagesCount`	`integer`	Optional	The total number of damages.
`wealth`	`UserStatsWealth`	Optional	The wealth.
`case1`	`UserStatsCase1`	Optional	The case1.

`UserStatsCase1`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional	The by rarity.
`openedCount`	`integer`	Optional	The total number of opened.

`UserStatsCase1ByRarity`

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

`UserStatsWealth`

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

`.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`	Optional
`__v`	`integer`	Optional
`value`	`number`	Optional	The value.
`rank`	`integer`	Optional	The rank.
`tier`	`string`	Optional	The tier.
`country`	`string`	Optional	The UUID of the country this user holds citizenship in.

`SkillDetail`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional	The current overall level of the entity.
`currentBarValue`	`number`	Optional	The current bar value.
`value`	`number`	Optional	The value.
`weapon`	`number`	Optional	The weapon.
`equipment`	`number`	Optional	The equipment.
`limited`	`number`	Optional	The limited.
`total`	`number`	Optional	The total.
`hourlyBarRegen`	`number`	Optional	The hourly bar regen.
`totalAfterSoftCap`	`number`	Optional	The total after soft cap.
`overflow`	`number`	Optional	The overflow.
`ammoPercent`	`number`	Optional	The ammo percent.
`buffsPercent`	`number`	Optional	The buffs percent.
`debuffsPercent`	`number`	Optional	The debuffs percent.
`militaryRankPercent`	`number`	Optional	The military rank percent.

`User`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`username`	`string`	Optional	The unique display name of the user.
`usernameLower`	`string`	Optional	The lowercase version of the username used for case-insensitive indexing.
`canOnboard`	`boolean`	Optional	Whether the user is a new player eligible for the onboarding tutorial.
`country`	`string`	Optional	The UUID of the country this user holds citizenship in.
`isActive`	`boolean`	Optional	Whether the user has logged in recently and is considered an active player.
`avatarUrl`	`string`	Optional	The CDN URL pointing to the user's profile picture.
`mu`	`string`	Optional	The UUID of the Military Unit this user belongs to.
`militaryRank`	`integer`	Optional	The total military rank points indicating the user's overall combat experience.
`createdAt`	`string`	Optional	The timestamp when this record was created.
`updatedAt`	`string`	Optional	The timestamp when this record was last modified.
`emailVerified`	`boolean`	Optional	Whether the user has verified their email address to unlock trading and chat.
`dates`	`UserDates`	Optional
`leveling`	`UserLeveling`	Optional	The leveling.
`stats`	`UserStats`	Optional	The stats.
`rankings`	`UserRankings`	Optional	The country's current standing in the global leaderboards.
`infos`	`UserInfos`	Optional	The infos.
`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	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`lastConnectionAt`	`string`	Optional	The timestamp of the user's last login.
`lastTakingControlAt`	`string`	Optional	The timestamp of the last taking control event.
`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	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`ammo`	`string`	Optional	The ammo.
`helmet`	`string`	Optional	The helmet.
`chest`	`string`	Optional	The chest.
`boots`	`string`	Optional	The boots.
`pants`	`string`	Optional	The pants.
`gloves`	`string`	Optional	The gloves.
`weapon`	`string`	Optional	The weapon.

`UserInfos`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`colorScheme`	`string`	Optional	The color scheme.
`description`	`string`	Optional	The description.
`font`	`string`	Optional	The font.
`isPremium`	`boolean`	Optional	The is premium.
`premiumGiftsCount`	`integer`	Optional	The total number of premium gifts.
`premiumMonthsCount`	`integer`	Optional	The total number of premium months.
`vicePresidentOf`	`string`	Optional	The vice president of.

`UserLeveling`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`level`	`integer`	Optional	The current overall level of the entity.
`totalXp`	`integer`	Optional	The total lifetime experience points accumulated.
`dailyXpLeft`	`integer`	Optional	The remaining experience points the user can earn today before hitting the daily cap.
`availableSkillPoints`	`integer`	Optional	Unspent skill points awarded from leveling up.
`spentSkillPoints`	`integer`	Optional	The spent skill points.
`totalSkillPoints`	`integer`	Optional	The total skill points.
`freeReset`	`integer`	Optional	The free reset.

`UserMissions`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`claimedAt`	`UserMissionsClaimedAt`	Optional	The claimed at.
`rerolledDailyMissions`	`integer`	Optional	The rerolled daily missions.
`rerolledWeeklyMissions`	`integer`	Optional	The rerolled weekly missions.

`UserMissionsClaimedAt`

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

`UserPreferences`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`autoReplaceOnBreak`	`boolean`	Optional	The auto replace on break.
`autoEquipMode`	`string`	Optional	The auto equip mode.
`appFont`	`string`	Optional	The app font.
`appPattern`	`string`	Optional	The app pattern.
`locale`	`string`	Optional	The locale.
`sfx`	`boolean`	Optional	The sfx.
`colorblind`	`boolean`	Optional	The colorblind.

`UserRankings`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`userDamages`	`RankingDetail`	Optional	The user damages.
`weeklyUserDamages`	`RankingDetail`	Optional	The weekly user damages.
`userWealth`	`RankingDetail`	Optional	The user wealth.
`userLevel`	`RankingDetail`	Optional	The user level.
`userReferrals`	`RankingDetail`	Optional	The user referrals.
`userTerrain`	`RankingDetail`	Optional	The user terrain.
`userCasesOpened`	`RankingDetail`	Optional	The user cases opened.
`userBounty`	`RankingDetail`	Optional	The user bounty.
`userGemsPurchased`	`RankingDetail`	Optional	The user gems purchased.
`userPremiumGifts`	`RankingDetail`	Optional	The user premium gifts.
`userPremiumMonths`	`RankingDetail`	Optional	The user premium months.
`userSubscribers`	`RankingDetail`	Optional	The user subscribers.

`UserSkills`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`energy`	`SkillDetail`	Optional	The energy.
`health`	`SkillDetail`	Optional	The health.
`hunger`	`SkillDetail`	Optional	The hunger.
`attack`	`SkillDetail`	Optional	The attack.
`companies`	`SkillDetail`	Optional	The companies.
`entrepreneurship`	`SkillDetail`	Optional	The entrepreneurship.
`production`	`SkillDetail`	Optional	The production.
`criticalChance`	`SkillDetail`	Optional	The critical chance.
`criticalDamages`	`SkillDetail`	Optional	The critical damages.
`armor`	`SkillDetail`	Optional	The armor.
`precision`	`SkillDetail`	Optional	The precision.
`dodge`	`SkillDetail`	Optional	The dodge.
`lootChance`	`SkillDetail`	Optional	The loot chance.
`management`	`SkillDetail`	Optional	The management.

`UserStats`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`estimatedCompanyValues`	`number`	Optional	The estimated company values.
`estimatedInventoryValue`	`number`	Optional	The estimated inventory value.
`estimatedWealth`	`number`	Optional	The estimated wealth.
`worksCount`	`integer`	Optional	The total number of works.
`damagesCount`	`integer`	Optional	The total number of damages.
`wealth`	`UserStatsWealth`	Optional	The wealth.
`case1`	`UserStatsCase1`	Optional	The case1.

`UserStatsCase1`

Field	Type	Required	Description
`_id`	`string`	Optional
`__v`	`integer`	Optional
`byRarity`	`UserStatsCase1ByRarity`	Optional	The by rarity.
`openedCount`	`integer`	Optional	The total number of opened.

`UserStatsCase1ByRarity`

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

`UserStatsWealth`

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

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