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:

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	Description
_id	string \| null	❌
__v	integer \| null	❌
value	number \| null	❌
rank	integer \| null	❌
tier	string \| null	❌
country	string \| null	❌

SkillDetail

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

UserDates

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

UserInfos

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
colorScheme	string \| null	❌
description	string \| null	❌
font	string \| null	❌
isPremium	boolean \| null	❌
premiumGiftsCount	integer \| null	❌
premiumMonthsCount	integer \| null	❌
vicePresidentOf	string \| null	❌

UserLeveling

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
level	integer \| null	❌
totalXp	integer \| null	❌
dailyXpLeft	integer \| null	❌
availableSkillPoints	integer \| null	❌
spentSkillPoints	integer \| null	❌
totalSkillPoints	integer \| null	❌
freeReset	integer \| null	❌

UserLite

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

UserRankings

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

UserSkills

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

UserStats

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
estimatedCompanyValues	number \| null	❌
estimatedInventoryValue	number \| null	❌
estimatedWealth	number \| null	❌
worksCount	integer \| null	❌
damagesCount	integer \| null	❌
wealth	UserStatsWealth \| null	❌
case1	UserStatsCase1 \| null	❌

UserStatsCase1

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
byRarity	UserStatsCase1ByRarity \| null	❌
openedCount	integer \| null	❌

UserStatsCase1ByRarity

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
common	integer \| null	❌
uncommon	integer \| null	❌
rare	integer \| null	❌
epic	integer \| null	❌
legendary	integer \| null	❌

UserStatsWealth

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
companies	number \| null	❌
items	number \| null	❌
money	number \| null	❌
equipments	number \| null	❌
weapons	number \| null	❌
total	number \| null	❌

---

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

Return Models

RankingDetail

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
value	number \| null	❌
rank	integer \| null	❌
tier	string \| null	❌
country	string \| null	❌

SkillDetail

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

UserDates

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

UserInfos

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
colorScheme	string \| null	❌
description	string \| null	❌
font	string \| null	❌
isPremium	boolean \| null	❌
premiumGiftsCount	integer \| null	❌
premiumMonthsCount	integer \| null	❌
vicePresidentOf	string \| null	❌

UserLeveling

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
level	integer \| null	❌
totalXp	integer \| null	❌
dailyXpLeft	integer \| null	❌
availableSkillPoints	integer \| null	❌
spentSkillPoints	integer \| null	❌
totalSkillPoints	integer \| null	❌
freeReset	integer \| null	❌

UserLite

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

UserRankings

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

UserSkills

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

UserStats

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
estimatedCompanyValues	number \| null	❌
estimatedInventoryValue	number \| null	❌
estimatedWealth	number \| null	❌
worksCount	integer \| null	❌
damagesCount	integer \| null	❌
wealth	UserStatsWealth \| null	❌
case1	UserStatsCase1 \| null	❌

UserStatsCase1

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
byRarity	UserStatsCase1ByRarity \| null	❌
openedCount	integer \| null	❌

UserStatsCase1ByRarity

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
common	integer \| null	❌
uncommon	integer \| null	❌
rare	integer \| null	❌
epic	integer \| null	❌
legendary	integer \| null	❌

UserStatsWealth

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
companies	number \| null	❌
items	number \| null	❌
money	number \| null	❌
equipments	number \| null	❌
weapons	number \| null	❌
total	number \| null	❌

---

.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	None
auto_items	bool	False
max_pages	int | float	inf
cursor_end	str | None	None

Return Models

CursorPage[UserLite]

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
items	array[UserLite]	✅
nextCursor	string \| null	❌
hasMore	boolean	❌

RankingDetail

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
value	number \| null	❌
rank	integer \| null	❌
tier	string \| null	❌
country	string \| null	❌

SkillDetail

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

UserDates

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

UserInfos

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
colorScheme	string \| null	❌
description	string \| null	❌
font	string \| null	❌
isPremium	boolean \| null	❌
premiumGiftsCount	integer \| null	❌
premiumMonthsCount	integer \| null	❌
vicePresidentOf	string \| null	❌

UserLeveling

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
level	integer \| null	❌
totalXp	integer \| null	❌
dailyXpLeft	integer \| null	❌
availableSkillPoints	integer \| null	❌
spentSkillPoints	integer \| null	❌
totalSkillPoints	integer \| null	❌
freeReset	integer \| null	❌

UserLite

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

UserRankings

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

UserSkills

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

UserStats

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
estimatedCompanyValues	number \| null	❌
estimatedInventoryValue	number \| null	❌
estimatedWealth	number \| null	❌
worksCount	integer \| null	❌
damagesCount	integer \| null	❌
wealth	UserStatsWealth \| null	❌
case1	UserStatsCase1 \| null	❌

UserStatsCase1

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
byRarity	UserStatsCase1ByRarity \| null	❌
openedCount	integer \| null	❌

UserStatsCase1ByRarity

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
common	integer \| null	❌
uncommon	integer \| null	❌
rare	integer \| null	❌
epic	integer \| null	❌
legendary	integer \| null	❌

UserStatsWealth

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
companies	number \| null	❌
items	number \| null	❌
money	number \| null	❌
equipments	number \| null	❌
weapons	number \| null	❌
total	number \| null	❌

---

.get_by_id()

Get a user's profile by ID.

Signature

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

Parameters

Name	Type	Default
user_id	str	*Required*

Return Models

RankingDetail

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
value	number \| null	❌
rank	integer \| null	❌
tier	string \| null	❌
country	string \| null	❌

SkillDetail

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

User

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

UserDates

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

UserEquipment

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
ammo	string \| null	❌
helmet	string \| null	❌
chest	string \| null	❌
boots	string \| null	❌
pants	string \| null	❌
gloves	string \| null	❌
weapon	string \| null	❌

UserInfos

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
colorScheme	string \| null	❌
description	string \| null	❌
font	string \| null	❌
isPremium	boolean \| null	❌
premiumGiftsCount	integer \| null	❌
premiumMonthsCount	integer \| null	❌
vicePresidentOf	string \| null	❌

UserLeveling

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
level	integer \| null	❌
totalXp	integer \| null	❌
dailyXpLeft	integer \| null	❌
availableSkillPoints	integer \| null	❌
spentSkillPoints	integer \| null	❌
totalSkillPoints	integer \| null	❌
freeReset	integer \| null	❌

UserMissions

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
claimedAt	UserMissionsClaimedAt \| null	❌
rerolledDailyMissions	integer \| null	❌
rerolledWeeklyMissions	integer \| null	❌

UserMissionsClaimedAt

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
starting	string \| null	❌
daily	string \| null	❌
weekly	string \| null	❌
monthly	string \| null	❌

UserPreferences

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
autoReplaceOnBreak	boolean \| null	❌
autoEquipMode	string \| null	❌
appFont	string \| null	❌
appPattern	string \| null	❌
locale	string \| null	❌
sfx	boolean \| null	❌
colorblind	boolean \| null	❌

UserRankings

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

UserSkills

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

UserStats

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
estimatedCompanyValues	number \| null	❌
estimatedInventoryValue	number \| null	❌
estimatedWealth	number \| null	❌
worksCount	integer \| null	❌
damagesCount	integer \| null	❌
wealth	UserStatsWealth \| null	❌
case1	UserStatsCase1 \| null	❌

UserStatsCase1

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
byRarity	UserStatsCase1ByRarity \| null	❌
openedCount	integer \| null	❌

UserStatsCase1ByRarity

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
common	integer \| null	❌
uncommon	integer \| null	❌
rare	integer \| null	❌
epic	integer \| null	❌
legendary	integer \| null	❌

UserStatsWealth

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
companies	number \| null	❌
items	number \| null	❌
money	number \| null	❌
equipments	number \| null	❌
weapons	number \| null	❌
total	number \| null	❌

---

.get_lite()

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

Signature

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

Parameters

Name	Type	Default
user_id	str	*Required*

Return Models

RankingDetail

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
value	number \| null	❌
rank	integer \| null	❌
tier	string \| null	❌
country	string \| null	❌

SkillDetail

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

UserDates

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

UserInfos

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
colorScheme	string \| null	❌
description	string \| null	❌
font	string \| null	❌
isPremium	boolean \| null	❌
premiumGiftsCount	integer \| null	❌
premiumMonthsCount	integer \| null	❌
vicePresidentOf	string \| null	❌

UserLeveling

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
level	integer \| null	❌
totalXp	integer \| null	❌
dailyXpLeft	integer \| null	❌
availableSkillPoints	integer \| null	❌
spentSkillPoints	integer \| null	❌
totalSkillPoints	integer \| null	❌
freeReset	integer \| null	❌

UserLite

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

UserRankings

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

UserSkills

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

UserStats

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
estimatedCompanyValues	number \| null	❌
estimatedInventoryValue	number \| null	❌
estimatedWealth	number \| null	❌
worksCount	integer \| null	❌
damagesCount	integer \| null	❌
wealth	UserStatsWealth \| null	❌
case1	UserStatsCase1 \| null	❌

UserStatsCase1

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
byRarity	UserStatsCase1ByRarity \| null	❌
openedCount	integer \| null	❌

UserStatsCase1ByRarity

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
common	integer \| null	❌
uncommon	integer \| null	❌
rare	integer \| null	❌
epic	integer \| null	❌
legendary	integer \| null	❌

UserStatsWealth

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
companies	number \| null	❌
items	number \| null	❌
money	number \| null	❌
equipments	number \| null	❌
weapons	number \| null	❌
total	number \| null	❌

---

.get_many()

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

Signature

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

Parameters

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

Return Models

RankingDetail

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
value	number \| null	❌
rank	integer \| null	❌
tier	string \| null	❌
country	string \| null	❌

SkillDetail

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

User

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

UserDates

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

UserEquipment

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
ammo	string \| null	❌
helmet	string \| null	❌
chest	string \| null	❌
boots	string \| null	❌
pants	string \| null	❌
gloves	string \| null	❌
weapon	string \| null	❌

UserInfos

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
colorScheme	string \| null	❌
description	string \| null	❌
font	string \| null	❌
isPremium	boolean \| null	❌
premiumGiftsCount	integer \| null	❌
premiumMonthsCount	integer \| null	❌
vicePresidentOf	string \| null	❌

UserLeveling

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
level	integer \| null	❌
totalXp	integer \| null	❌
dailyXpLeft	integer \| null	❌
availableSkillPoints	integer \| null	❌
spentSkillPoints	integer \| null	❌
totalSkillPoints	integer \| null	❌
freeReset	integer \| null	❌

UserMissions

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
claimedAt	UserMissionsClaimedAt \| null	❌
rerolledDailyMissions	integer \| null	❌
rerolledWeeklyMissions	integer \| null	❌

UserMissionsClaimedAt

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
starting	string \| null	❌
daily	string \| null	❌
weekly	string \| null	❌
monthly	string \| null	❌

UserPreferences

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
autoReplaceOnBreak	boolean \| null	❌
autoEquipMode	string \| null	❌
appFont	string \| null	❌
appPattern	string \| null	❌
locale	string \| null	❌
sfx	boolean \| null	❌
colorblind	boolean \| null	❌

UserRankings

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

UserSkills

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

UserStats

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
estimatedCompanyValues	number \| null	❌
estimatedInventoryValue	number \| null	❌
estimatedWealth	number \| null	❌
worksCount	integer \| null	❌
damagesCount	integer \| null	❌
wealth	UserStatsWealth \| null	❌
case1	UserStatsCase1 \| null	❌

UserStatsCase1

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
byRarity	UserStatsCase1ByRarity \| null	❌
openedCount	integer \| null	❌

UserStatsCase1ByRarity

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
common	integer \| null	❌
uncommon	integer \| null	❌
rare	integer \| null	❌
epic	integer \| null	❌
legendary	integer \| null	❌

UserStatsWealth

Field	Type	Required	Description
_id	string \| null	❌
__v	integer \| null	❌
companies	number \| null	❌
items	number \| null	❌
money	number \| null	❌
equipments	number \| null	❌
weapons	number \| null	❌
total	number \| null	❌

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---