user

class pyZUnivers.user.User(username: str)

Represents a ZUnivers player and contains various information about the player.

All methods (static or not) make an additional API request.

url

The URL to the ZUnivers player page.

Type:

str

id

The ZUnivers player identification.

Type:

str

discord_id

The Discord user identification.

Type:

str

discord_avatar

The URL to the Discord user avatar.

Type:

str

balance

The amount of ZUMonnaie the player has.

Type:

int

lore_dust

The amount of Poudre créatrice the player has.

Type:

int

lore_fragment

The amount of Cristal d’histoire the player has.

Type:

int

upgrade_dust

The amount of Eclat d’étoile the player has.

Type:

int

rank

The ZUnivers rank name.

Type:

str

banner

The UserBanner object for the user.

Type:

UserBanner

is_active

True if the ZUniver player have done a command in the last 30 days, False otherwise.

Type:

bool

leaderboards

The UserLeaderboards object for the user.

Type:

UserLeaderboards

cards

The number of cards the player owns.

Type:

int

unique_cards

The number of unique cards the player owns. (format: unique_cards/possible_unique_cards)

Type:

str

unique_golden_cards

The number of unique golden cards the player owns. (format: unique_golden_cards/possible_unique_golden_cards)

Type:

str

unique_constellation_cards

The number of unique constellation cards the player owns. (format: unique_constellation_cards/possible_unique_constellation_cards)

Type:

str

unique_golden_constellation_cards

The number of unique golden constellation cards the player owns. (format: unique_golden_constellation_cards/possible_unique_golden_constellation_cards)

Type:

str

tickets

The number of tickets the player have scratched.

Type:

int

achievements

The number of achievements the player have done. (format: achievements_done/achievements_possible)

Type:

str

subscription

The Subscription object for the player if they have one, False otherwise.

Type:

bool|Subscription

tradeless

True if the player has never made a trade, False otherwise.

Type:

bool

today_trades

The number of trades the player have made today. (format: trades_made_today/trade_possible_today)

Type:

str

subscription_bonus

The number of player subscription bonus. (format: subscription_bonus_obtained/subscription_bonus_possible)

Type:

str

static get_advent_calendar(username: str)

Checks if a user has opened their advent calendar for the current day.

Parameters:

username (str) – The username of the user.

Returns:

True if the user has opened the advent calendar for the current day,

False otherwise.

Return type:

bool

static get_advent_score(username: str) → int

Calculates the advent score for a given username by retrieving calendar data and calculating the score based on various criteria.

Parameters:

username (str) – The username of the user.

Returns:

The advent score for the user.

Return type:

int

get_challenge() → Challenges

Returns the Challenges object for the user.

Returns:

The Challenges object.

Return type:

Challenges

static get_checker(username: str) → Checker

Returns a dictionary of boolean containing information about user journa, bonus and advent calendar.

Parameters:

username (str) – The username of the user.

Returns:

A dictionary containing information about user journa, bonus, and advent calendar.

Return type:

dict

static get_insomniaque(username: str) → Insomniaque

Returns the Insomniaque object for the given username.

Parameters:

username (str) – The username of the user.

Returns:

The Insomniaque object.

Return type:

Insomniaque

get_inventory(search: str = None) → List[UserInventoryObject]

Returns the inventory of the user.

Parameters:

search (str, optional) – A search query to filter the inventory. Defaults to None.

Returns:

The inventory of the user.

Return type:

List[UserInventoryObject]

static get_journa(username: str) → bool

Returns a boolean indicating whether the user have done the journa command or not.

Parameters:

username (str) – The username of the user.

Returns:

True if the user has done the journa command, False otherwise.

Return type:

bool

get_loot_infos() → UserLootInfos

Returns the UserLootInfos object for the user.

Returns:

The UserLootInfos object.

Return type:

UserLootInfos

get_overview() → UserOverview

Returns the UserOverview object for the user.

Returns:

The UserOverview object.

Return type:

UserOverview

get_reputation() → UserReputation

Returns the UserReputation object for the user.

Returns:

The UserReputation object.

Return type:

UserReputation

static get_yearly(username: str, year: int)

Returns the number of days left for the user to complete a yearful looting or False if it’s complete.

Parameters:

• username (str) – The username of the user.

• year (int) – The year for which to check the yearly looting.

Returns:

The number of days left for the user to complete the yearly looting,

or False if it’s already complete.

Return type:

int|bool