Models#

Models for asyncpixel data objects.

class asyncpixel.models.Auction(*args: Any, **kwargs: Any)[source]#

Main auction object.

Parameters
  • page (int) – Page of auction data.

  • total_pages (int) – Total pages of auctions.

  • total_auctions (int) – Total number of auctions.

  • last_updated (datetime.datetime) – Time last updated.

  • auctions (List[AuctionItem]) – List of auctions.

class asyncpixel.models.AuctionItem(*args: Any, **kwargs: Any)[source]#

Auction model.

Parameters
  • uuid (UUID4) – Id of auction.

  • auctioneer (UUID4) – Id of seller.

  • profile_id (UUID4) – Profile_id of seller.

  • coop (str) – Amount bidded.

  • start (datetime.datetime) – Start time of auction.

  • end (datetime.datetime) – End time of auction.

  • item_name (str) – Name of auction item.

  • item_lore (str) – Lore of item.

  • extra (str) – extra.

  • category (str) – Item category

  • tier (str) – Tier of item.

  • starting_bid (int) – Starting Auction bid.

  • item_bytes (str) – Bytes of item.

  • claimed (bool) – Wehther the auction has been won.

  • claimed_bidders (Optional[List[UUID4]]) – Amount bidded.

  • highest_bid_amount (int) – Highest amount bidded.

  • bids (List[Bids]) – List of bids on auction.

  • id (str) – Id of auction.

  • bin (bool) – Whether the auction is BIN (Buy instantly)

active() bool[source]#

Return if auction is active - you can bid on it.

lowest_possible_bid() int[source]#

Returns next lowest possible bid.

class asyncpixel.models.Bazaar(*args: Any, **kwargs: Any)[source]#

Bazaar object.

Parameters
class asyncpixel.models.BazaarItem(*args: Any, **kwargs: Any)[source]#

Bazaar item.

Parameters
  • product_id (str) – Product id.

  • buy_summary (List[BazaarBuySummary]) – List of sell summary.

  • buy_summary – List of buy summary.

  • quick_status (BazaarQuickStatus) – Quick status.

class asyncpixel.models.BazaarQuickStatus(*args: Any, **kwargs: Any)[source]#

Bazaar quick status.

Parameters
  • product_id (str) – Id of product.

  • sell_price (int) – Sell price per unit.

  • sell_volume (float) – Volume of sale.

  • sell_moving_week (int) – Sell moving week.

  • sell_orders (int) – How many orders.

  • buy_price (int) – Buy price.

  • buy_volume (float) – Volume of purchase.

  • buy_moving_week (int) – How many orders.

  • buy_orders (int) – How many orders.

class asyncpixel.models.BazaarSummary(*args: Any, **kwargs: Any)[source]#

Bazaar object.

Parameters
  • amount (int) – Amount available to buy.

  • price_per_unit (float) – Price per unit.

  • orders (int) – How many orders.

class asyncpixel.models.Bids(*args: Any, **kwargs: Any)[source]#

Bid models.

Parameters
  • auction_id (UUID4) – Id of auction.

  • bidder (UUID4) – Id of bidder.

  • profile_id (UUID4) – Profile_id of seller.

  • amount (str) – Amount bidded.

  • timestamp (datetime.datetime) – Timestamp of bid placed.

class asyncpixel.models.Booster(*args: Any, **kwargs: Any)[source]#

Main booster class.

Parameters
  • id (str) – ID

  • purchaser_uuid (uuid.UUID) – UUID of booster.

  • amount (int) – Amount of boosters.

  • original_length (int) – Original length of booster.

  • length (int) – Length of booster.

  • game_type (GameType) – Game type.

  • date_activated (datetime.datetime) – Date boost activated.

  • stacked (Union[List[uuid.UUID], bool]) – Wether boosters stacked.

class asyncpixel.models.Boosters(*args: Any, **kwargs: Any)[source]#

Object containing boosters.

Parameters
  • booster_state_decrementing (bool) – Wether booster state decrementing.

  • boosters (List[Booster]) – List of boosters online.

class asyncpixel.models.Friend(*args: Any, **kwargs: Any)[source]#

Friend object.

Parameters
  • id (bool) – Id of friend.

  • uuid_sender (UUID4) – UUID of player sending friend request.

  • uuid_receiver (UUID4) – UUID of player receiving friend request.

  • started (datetime.datetime) – Time players started being friends.

class asyncpixel.models.Game(*args: Any, **kwargs: Any)[source]#

Game class.

Parameters
  • date (datetime.datetime) – Time game started.

  • game_type (GameType) – Game Type.

  • mode (Optional[str]) – Game mode.

  • map (Optional[str]) – Map the game is on.

  • ended (Optional[datetime.datetime]) – Time game ended. Defaults to None.

class asyncpixel.models.GameCounts(*args: Any, **kwargs: Any)[source]#

Game Count class.

Parameters
  • games (Dict[str, GameCountsGame]) – dict of all game and their game counts.

  • player_count (int) – total number of players online.

class asyncpixel.models.GameCountsGame(*args: Any, **kwargs: Any)[source]#

Game count game.

Parameters
  • players (int) – Number of players in a game.

  • uuid_sender (Optional[Dict[str, int]]) – Dict of game modes and people in them.

class asyncpixel.models.GameType(*args: Any, **kwargs: Any)[source]#

Main game class.

Parameters
  • id (str) – ID

  • purchaser_uuid (uuid.UUID) – UUID of booster.

  • amount (int) – Amount of boosters.

  • original_length (int) – Original length of booster.

  • length (int) – Length of booster.

  • game_type (int) – Game type.

  • date_activated (datetime.datetime) – Date boost activated.

  • stacked (Union[List[uuid.UUID], bool]) – Wether boosters stacked.

class asyncpixel.models.Guild(*args: Any, **kwargs: Any)[source]#

Guild object.

Parameters
  • id (str) – Guild ID.

  • created (datetime.datetime) – Timestamp this guild was created at.

  • name (str) – Name of guild.

  • (str (name_lower) – Priority of role.

  • description (str) – Description of this guild that appears in the guild list and /g info.

  • tag (str) – Tag of guild.

  • exp (int) – Exp or guild.

  • members (List[GuildMembers]) – Array of guild members.

  • achievements (Dict[str, int]) – Guild achievements earned and the current progress.

  • ranks (List[Rank]) – Array of guild ranks.

  • joinable (bool) – Whether this guild can be joined using /g join.

  • legacy_ranking (int) – Ranking in the number of guild coins owned in the legacy guild system (0-indexed).

  • publicly_listed (bool) – Whether this guild is listed in the Guild Finder.

  • preferred_games (List[str]) – This guild’s set preferred games.

  • chat_mute (datetime.datetime) – Timestamp guild chat will be unmuted at, or 0 if guild chat is not muted.

  • guild_exp_by_game_type (Dict[str, str]) – Amount of EXP earned for this guild by which game it was earned in.

  • tag_color (Optional[str]) – Color of this guild’s tag, if set. Defaults to None.

class asyncpixel.models.GuildMembers(*args: Any, **kwargs: Any)[source]#

Members in a guild.

Parameters
  • uuid (uuid.UUID) – UUID of player.

  • rank (str) – Rank of player.

  • joined (datetime.datetime) – Time player joined guild.

  • exp_history (Dict[str, int]) – Exp history of player.

  • quest_participation (int) – How many quests the player has participated in.

  • muted_till (Optional[datetime.datetime]) – Time player unmuted. Defaults to None.

class asyncpixel.models.InvArmor(*args: Any, **kwargs: Any)[source]#

Armor.

Parameters
  • type (int) – Type of armor.

  • data (str) – Data of armor.

class asyncpixel.models.Item(*args: Any, **kwargs: Any)[source]#

News Item.

Parameters
  • material (str) – Material of article.

  • data (Optional[int]) – Data.

class asyncpixel.models.Key(*args: Any, **kwargs: Any)[source]#

Main class for key data.

Parameters
  • key (uuid.UUID) – key text.

  • owner (uuid.UUID) – uuid of owner.

  • limit (int) – Limit of toal queries.

  • queries_in_past_min (int) – Queries in the past minute.

  • total_queries (int) – Total queries using the key.

class asyncpixel.models.Leaderboards(*args: Any, **kwargs: Any)[source]#

Game count game.

Parameters
  • path (int) – Path.

  • prefix (str) – Prefix.

  • title (str) – Title of leaderboard.

  • location (Tuple[int, int, int]) – Location of leaderboard in lobby.

  • count (int) – Count of leaderboards.

  • leaders (List[uuid.UUID]) – List of leaders on the leaderboard.

class asyncpixel.models.Members(*args: Any, **kwargs: Any)[source]#

Member.

Parameters
  • last_save (datetime.datetime) – Time last saved.

  • inv_armor (InvArmor) – Armor.

  • first_join (datetime.datetime) – Time first joined.

  • first_join_hub (Optional[datetime.datetime]) – first joined hub.

  • stats (Dict[str, int]) – Member stats.

  • objectives (Dict[str, Objective]) – Objectives.

  • tutorial (List[str]) – Tutorial.

  • quests (Dict[str, Quests]) – Quests done.

  • coin_purse (Optional[int]) – Amount of coins in purse.

  • last_death (datetime.datetime) – Time last died.

  • crafted_generators (List[str]) – Crafted generators.

  • visited_zones (Optional[List[str]]) – Visited zones.

  • fairy_souls_collected (int) – Souls collected.

  • fairy_souls (Optional[int]) – Fairy souls.

  • death_count (Optional[int]) – death count.

  • slayer_bosses (Dict[str, Dict[str, Any]]) – Slayer bosses.

  • pets (List[Any]) – Pets.

property fairy_bonus: Dict[str, int]#

Bonus from fairy.

Returns

Fairy bonus.

Return type

Dict[str, int]

class asyncpixel.models.News(*args: Any, **kwargs: Any)[source]#

News object.

Parameters
  • item (Item) – News item.

  • link (str) – Link to article.

  • text (text) – Text of news.

  • title (str) – Title of news article.

class asyncpixel.models.Objective(*args: Any, **kwargs: Any)[source]#

Armor.

Parameters
  • status (str) – Status of objective.

  • progress (int) – Progress through objective.

  • completed_at (Optional[datetime.datetime]) – Time compelted at. Defaults to None.

class asyncpixel.models.Pattern(*args: Any, **kwargs: Any)[source]#

Pattern.

Parameters
  • color (int) – colour.

  • pattern (str) – pattern.

class asyncpixel.models.Player(*args: Any, **kwargs: Any)[source]#

Player.

Parameters
  • uuid (UUID4) – uuid of user.

  • displayname (Optional[str]) – Display name of user.

  • rank (Optional[str]) – Rank of user

  • first_login (datetime.datetime) – First login date.

  • last_login (Optional[datetime.datetime]) – Most recent login date.

  • last_logout (Optional[datetime.datetime]) – Last logout.

  • stats (Stats) – Stats for various game types.

  • social_media (Optional[Social]) – Social media accounts.

  • id (Optional[str]) – id of user.

  • playername (Optional[str]) – Playername.

  • known_aliases (Optional[List[str]]) – known aliases.

  • known_aliases_lower (Optional[List[str]]) – known aliases in lowercase.

  • achievements_one_time (Optional[List[str]]) – Achievements.

  • mc_version_rp (Optional[str]) – Minecraft version.

  • network_exp (Optional[float]) – Network experience.

  • karma (Optional[int]) – Player karma.

  • last_adsense_generate_time (Optional[datetime.datetime]) – Last generate time for adsense.

  • last_claimed_reward (Optional[int]) – Last claimed reward.

  • total_rewards (Optional[int]) – Total rewards.

  • total_daily_rewards (Optional[int]) – Total daily awards.

  • reward_streak (Optional[int]) – Current reward streak.

  • reward_score (Optional[int]) – Reward score.

  • reward_high_score (Optional[int]) – High score for rewards.

  • friend_requests_uuid (Optional[List[UUID4]]) – UUID of friend requests.

  • achievement_tracking (Optional[List[str]]) – Achievement tracking.

  • achievement_points (Optional[int]) – achievement points.

  • current_gadget (Optional[str]) – Current equipped gadget.

  • channel (Optional[str]) – Channel.

  • most_recent_game_type (Optional[GameType]) – Most recent Game Type that has been played.

  • level (Optional[float]) – Level of user.

  • raw (Dict[str, Any]) – raw data

class asyncpixel.models.Profile(*args: Any, **kwargs: Any)[source]#

Profile.

Parameters
  • profile_id (str) – Id of profile

  • cute_name (Optional[str]) – Cute name of profile

  • members (Dict[str, Members]) – Dict of all members in profile.

class asyncpixel.models.Quests(*args: Any, **kwargs: Any)[source]#

Armor.

Parameters
class asyncpixel.models.Rank(*args: Any, **kwargs: Any)[source]#

Rank.

Parameters
  • name (str) – Name of rank.

  • default (bool) – wether its the default.

  • created (int) – Created.

  • priority (int) – Priority of role.

  • tag (str) – Tag of role.

class asyncpixel.models.Social(*args: Any, **kwargs: Any)[source]#

Social accounts.

Parameters
  • twitter (Optional[str]) – Twitter.

  • youtube (Optional[str]) – YouTube.

  • instagram (Optional[str]) – Instagram.

  • twitch (Optional[str]) – Twitch.

  • discord (Optional[str]) – Discord.

  • hypixel_forums (Optional[str]) – Hypixel Forums.

class asyncpixel.models.Stats(*args: Any, **kwargs: Any)[source]#

Game Stats.

Parameters
  • bedwars (Optional[Bedwars]) – bedwars stats.

  • arcade (Optional[Arcade]) – Arcade stats.

  • build_battle (Optional[BuildBattle]) – Build Battle stats.

  • duels (Optional[Duels]) – Duels stats.

  • battleground (Optional[Battleground]) – Battleground stats.

  • hunger_games (Optional[HungerGames]) – Hunger Games stats.

  • ginger_bread (Optional[GingerBread]) – Ginger Bread stats.

  • paintball (Optional[Paintball]) – Paintball stats.

  • quake (Optional[Quake]) – Quake stats.

  • vampirez (Optional[VampireZ]) – VampireZ stats.

  • tnt_games (Optional[TNTGames]) – TNT Games stats.

  • uhc (Optional[UHC]) – UHC stats.

  • mcgo (Optional[MCGO]) – MCGO stats.

  • walls3 (Optional[Walls3]) – Walls3 stats.

  • walls (Optional[Walls]) – Walls stats.

  • arena (Optional[Arena]) – Arena stats.

  • sky_clash (Optional[SkyClash]) – SkyClash stats.

  • pit (Optional[Pit]) – Pit stats.

  • housing (Optional[Housing]) – Housing stats.

  • legacy (Optional[Legacy]) – Legacy stats.

class asyncpixel.models.Status(*args: Any, **kwargs: Any)[source]#

Status data object.

Parameters
  • online (bool) – Wether player is online.

  • game_type (Optional[GameType]) – Current game player is playing. Defaults to None.

  • mode (Optional[str]) – Mode of current game. Defaults to None.

class asyncpixel.models.WatchDog(*args: Any, **kwargs: Any)[source]#

Base class for watchdog.

Parameters
  • watchdog_last_minute (int) – Watchdog bans in last minute.

  • staff_rolling_daily (int) – Staff bans in the day.

  • watchdog_total (int) – Watchdog total bans.

  • watchdog_rolling_daily (int) – Watchdog bans in the day.

  • staff_total (int) – Staff total bans.