Reference

Client

class asyncpixel.Hypixel(api_key=None)[source]

Client class for hypixel wrapper.

async auction_from_player(player)[source]

Get auction data from player.

Parameters

player (str) – player.

Returns

list of auction items.

Return type

List[AuctionItem]

async auction_from_profile(profile_id)[source]

Get auction data from profile.

Parameters

profile_id (str) – profile id.

Returns

list of auction items.

Return type

List[AuctionItem]

async auction_from_uuid(uuid)[source]

Get auction from uuid.

Parameters

uuid (str) – minecraft uuid.

Returns

list of auctions.

Return type

List[AuctionItem]

async auctions(page=0, retry=3)[source]

Get the auctions available.

Parameters
  • page (int, optional) – Page of auction list you want. Defaults to 0.

  • retry (int) – Amount of retries to get the data from the api Defaults to 3.

Returns

Auction object.

Return type

Auction

async bazaar()[source]

Get info of the items in the bazaar.

Returns

object for bazzar.

Return type

Bazaar

async boosters()[source]

Get the current online boosters.

Returns

object containing boosters.

Return type

Boosters

async close()[source]

Used for safe client cleanup.

Return type

None

async game_count()[source]

Gets number of players per game.

Returns

game counts.

Return type

GameCounts

async guild_by_id(guild_id)[source]

Get guild by id.

Parameters

guild_id (str) – id of guild.

Returns

guild object.

Return type

Guild

async guild_by_name(guild_name)[source]

Get guild by name.

Parameters

guild_name (str) – name of guild.

Returns

guild object.

Return type

Guild

async guild_by_player(player_uuid)[source]

Get guild by player.

Parameters

player_uuid (str) – uuid of a player in the guild.

Returns

guild object.

Return type

Guild

async key_data(key=None)[source]

Get information about an api key.

Parameters

key (str, optional) – api key. Defaults token provided in class.

Raises

InvalidApiKeyError – No api key available.

Returns

Key object.

Return type

Key

async leaderboards()[source]

Get the current leaderboards.

Returns

raw json response.

Return type

Dict[str, Leaderboards]

async news()[source]

Get current skyblock news.

Returns

List of news objects.

Return type

List[News]

async player(uuid)[source]

Get information about a player from their uuid.

Parameters

uuid (UUID4) – uuid of player.

Returns

player object.

Return type

Player

async player_count()[source]

Get the current amount of players online.

Returns

number of online players.

Return type

int

async player_friends(uuid)[source]

Get a list of a players friends.

Parameters

uuid (str) – the uuid of the player you wish to get friends from.

Returns

returns a list of friend elements.

Return type

List[Friend]

async player_status(uuid)[source]

Get current online status about a player.

Parameters

uuid (str) – uuid of player.

Returns

Status object of player.

Return type

Status

async profile(profile)[source]

Get profile info of a skyblock player.

Parameters

profile (str) – profile id of player can be gotten from running profiles.

Returns

Profile if it exists

Return type

Union[Profile, None]

async profiles(uuid)[source]

Get info on a profile.

Parameters

uuid (str) – uuid of player.

Returns

json response.

Return type

Dict[str, Profile]

async recent_games(uuid)[source]

Get recent games of a player.

Parameters

uuid (str) – uuid of player.

Returns

list of recent games.

Return type

List[Game]

async resources_achievements()[source]

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

async resources_challenges()[source]

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

async resources_guilds_achievements()[source]

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

async resources_guilds_permissions()[source]

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

async resources_quests()[source]

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

async resources_skyblock_collections()[source]

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

async resources_skyblock_skills()[source]

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

async uuid_from_name(username)[source]

Helper method to get uuid from username.

Parameters

username (str) – username of player

Returns

uuid of player

Return type

UUID4

async watchdog_stats()[source]

Get current watchdog stats.

Returns

WatchDog stats object.

Return type

WatchDog

Exceptions

Custom exceptions for asyncpixel.

exception asyncpixel.exceptions.ApiNoSuccessError(source)[source]

Exception raised when api has an error.

exception asyncpixel.exceptions.InvalidApiKeyError(message='Entered API key is not valid')[source]

Exception raised when the API key is invalid.

exception asyncpixel.exceptions.RateLimitError(retry_after)[source]

Exception raised when Hypixel ratelimit is reached.

Models

Models for asyncpixel data objects.

class asyncpixel.models.Auction(*args, **kwargs)[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, **kwargs)[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()[source]

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

Return type

bool

lowest_possible_bid()[source]

Returns next lowest possible bid.

Return type

int

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

Bazaar object.

Parameters
class asyncpixel.models.BazaarItem(*args, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[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 (int) – Game type.

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

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

class asyncpixel.models.Guild(*args, **kwargs)[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, **kwargs)[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, **kwargs)[source]

Armor.

Parameters
  • type (int) – Type of armor.

  • data (str) – Data of armor.

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

News Item.

Parameters
  • material (str) – Material of article.

  • data (Optional[int]) – Data.

class asyncpixel.models.Key(*args, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[source]

Pattern.

Parameters
  • color (int) – colour.

  • pattern (str) – pattern.

class asyncpixel.models.Player(*args, **kwargs)[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, **kwargs)[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, **kwargs)[source]

Armor.

Parameters
class asyncpixel.models.Rank(*args, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[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, **kwargs)[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.

Player Stats

Player Stats.

class asyncpixel.models.players.Arcade(*args, **kwargs)[source]

Arcade games stats.

Parameters

coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

class asyncpixel.models.players.Arena(*args, **kwargs)[source]

Arena games stats.

Parameters

coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

class asyncpixel.models.players.Battleground(*args, **kwargs)[source]

Battleground games stats.

Parameters

coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

class asyncpixel.models.players.Bedwars(*args, **kwargs)[source]

Bedwars Stats.

Parameters
  • kills (int) – Total kills across all Bedwars gamemodes. Defaults to 0.

  • wins (int) – Total wins across all Bedwars gamemodes. Defaults to 0.

  • coins (int) – Total coins collected. Defaults to 0.

  • games_played (int) – Number of bedwars games played. Defaults to 0.

  • final_deaths (int) – Number of final deaths across all Bedwars gamemodes. Defaults to 0.

  • deaths (int) – Number of deaths across all Bedwars gamemodes. Defaults to 0.

  • final_kills (int) – Number of final kills across all Bedwars gamemodes. Defaults to 0.

  • losses (int) – Total bedwars games lost. Defaults to 0.

  • beds_lost (int) – Number of beds lost across all Bedwars gamemodes. Defaults to 0.

  • beds_broken (int) – Number of beds broken across all Bedwars gamemodes. Defaults to 0.

  • singles (Optional[BedwarsGame]) – Stats for the singles Gamemode.

  • doubles (Optional[BedwarsGame]) – Stats for the doubles Gamemode.

  • triples (Optional[BedwarsGame]) – Stats for the triples Gamemode.

  • quads (Optional[BedwarsGame]) – Stats for the quads Gamemode.

  • four_v_four (Optional[BedwarsGame]) – Stats for the four vs four Gamemode.

  • quads_ultimate (Optional[BedwarsGame]) – Stats for the quads ultimate Gamemode.

  • doubles_ultimate (Optional[BedwarsGame]) – Stats for the doubles ultimate Gamemode.

  • castle (Optional[BedwarsGame]) – Stats for the castle Gamemode.

  • entity_attack_deaths (int) – Deaths to an entity. Defaults to 0.

  • entity_attack_final_deaths (int) – Final deaths to an entity. Defaults to 0.

  • fall_deaths (int) – Overall fall deaths. Defaults to 0.

  • fall_final_deaths (int) – Overall final fall deaths Defaults to 0.

  • projectile_deaths (int) – Projectile deaths. Defaults to 0.

  • suffocation_deaths (int) – Overall suffocation deaths. Defaults to 0.

  • magic_deaths (int) – Overall magic deaths. Defaults to 0.

  • entity_explosion_deaths (int) – Overall explosion deaths. Defaults to 0.

  • magic_final_deaths (int) – Overall magic final deaths. Defaults to 0.

  • void_deaths (int) – Overall void deaths. Defaults to 0.

  • void_final_death (int) – Overall void final deaths. Defaults to 0.

  • fire_tick_final_death (int) – Overall fire final deaths. Defaults to 0.

  • void_kills (int) – Overall void kills. Defaults to 0.

  • entity_attack_kills (int) – Overall entity attack kills. Defaults to 0.

  • entity_attack_final_kills (int) – Overall entity attack final kills. Defaults to 0.

  • projectile_final_kills (int) – Overall projectile final kills. Defaults to 0.

  • entity_explosion_kills (int) – Overall entity explosion kills. Defaults to 0.

  • projectile_kills (int) – Overall projectile kills. Defaults to 0.

  • fall_final_kills (int) – Overall final fall kills. Defaults to 0.

  • fall_kills (int) – Overall fall kills. Defaults to 0.

  • resources_collected (int) – Overall resources collected. Defaults to 0.

  • iron_resources_collected (int) – Overall iron resources collected. Defaults to 0.

  • diamond_resources_collected (int) – Overall diamond resources collected. Defaults to 0.

  • emerald_resources_collected (int) – Overall emerald resources collected. Defaults to 0.

  • items_purchased (int) – Overall items purchased. Defaults to 0.

  • permanent_items_purchased (int) – Overall permanent items purchased. Defaults to 0.

  • bedwars_box_rares (int) – Bedwars boxes that are rare. Defaults to 0.

  • bedwars_box (int) – Total Bedwars boxes. Defaults to 0.

  • chest_history_new (List[str]) – Chest history. Defaults to [].

  • bedwars_box_commons (int) – Total common Bedwars boxes. Defaults to 0.

  • spray_glyph_field (str) – Current spray glyph. Defaults to “”.

  • active_island_topper (str) – Current island topper. Defaults to “”.

  • active_projectile_trail (str) – Current projectile trail. Defaults to “”.

  • bedwars_easter_boxes (int) – Bedwars easters boxes. Defaults to 0.

  • Bedwars_opened_chests (int) – Total chests opened in Bedwars. Defaults to 0.

  • Bedwars_opened_rares (int) – Total rare chests opened in Bedwars. Defaults to 0.

  • Bedwars_opened_commons (int) – Total common chests opened in Bedwars. Defaults to 0.

  • active_npc_skin (str) – Current active NPC skin. Defaults to “”.

  • favourites_2 (str) – Favourites. Defaults to “”.

  • Bedwars_opened_epics (int) – Total epic chests opened in Bedwars. Defaults to 0.

  • active_death_cry (str) – Equiped active death cry. Defaults to “”.

  • active_kill_effect (str) – Equiped kill effect. Defaults to “”.

  • active_sprays (str) – Equiped spray. Defaults to “”.

  • active_glyph (str) – Active glyph. Defaults to “”.

  • selected_ultimate (str) – Selected Ultimate. Defaults to “”.

property beds_broken_per_lost: float

Beds broken per Beds lost.

Returns

ratio between beds broken and beds lost.

Return type

float

property final_kills_per_kills: float

Final kills per final deaths.

Returns

ratio between kills and deaths.

Return type

float

property win_lose: float

Wins per losses.

Returns

ratio between game wins and game losses.

Return type

float

class asyncpixel.models.players.BedwarsGame(*args, **kwargs)[source]

Bedwars GameMode stats.

Parameters
  • items_purchased (int) – Total Items purchased. Defaults to 0.

  • diamond_resources_collected (int) – Total diamonds collected. Defaults to 0.

  • games_played (int) – Number of games played. Defaults to 0.

  • losses (int) – Games lost for this Game Mode. Defaults to 0.

  • gold_resources_collected (int) – Total gold collected. Defaults to 0.

  • void_deaths (int) – Deaths to the void Defaults to 0.

  • deaths (int) – Total deaths. Defaults to 0.

  • winstreak (int) – Current winstreak. Defaults to 0.

  • beds_lost (int) – Total beds lost. Defaults to 0.

  • final_deaths (int) – Total final deaths. Defaults to 0.

  • entity_attack_deaths (int) – Number of deaths to an entity. Defaults to 0.

  • beds_broken (int) – Beds broken. Defaults to 0.

  • entity_attack_final_deaths (int) – Number of deaths to an entity. Defaults to 0.

  • fall_deaths (int) – Total deaths from fall damage. Defaults to 0.

  • magic_deaths (int) – Total deaths to magic. Defaults to 0.

  • permanent_items_purchased (int) – Number of items that are not lost in the game purchased. Defaults to 0.

  • void_kills (int) – Kills using the void. Defaults to 0.

  • kills (int) – Total Total kills. Defaults to 0.

  • wins (int) – Total games won. Defaults to 0.

  • void_final_deaths (int) – Total final deaths to the void. Defaults to 0.

  • final_kills (int) – Total final kills. Defaults to 0.

property beds_broken_per_lost: float

Beds broken per Beds lost.

Returns

ratio between beds broken and lost.

Return type

float

property final_kills_per_kills: float

Final kills per kills.

Returns

ratio between final kills and kills.

Return type

float

property win_per_lose: float

Wins per losses.

Returns

ratio between game wins and game losses.

Return type

float

class asyncpixel.models.players.BuildBattle(*args, **kwargs)[source]

Build Battle games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • games_played (int) – Total games played. Defaults to 0.

  • score (int) – Score. Defaults to 0.

class asyncpixel.models.players.Duels(*args, **kwargs)[source]

Duels games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • deaths (int) – Totaldeaths. Defaults to 0.

  • losses (int) – Games lost. Defaults to 0.

  • losses – Games won. Defaults to 0.

  • damage_dealt (int) – Damge dealt in total. Defaults to 0.

  • rounds_played (int) – Number of rounds played. Defaults to 0.

class asyncpixel.models.players.GingerBread(*args, **kwargs)[source]

GingerBread games stats.

Parameters

coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

class asyncpixel.models.players.Housing(*args, **kwargs)[source]

Housing games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • total_kills (int) – Total kills. Defaults to 0.

  • total_wins (int) – Total wins. Defaults to 0.

class asyncpixel.models.players.HungerGames(*args, **kwargs)[source]

Hunger Games games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • deaths (int) – Total deaths. Defaults to 0.

  • damge (int) – Total damage dealt. Defaults to 0.

  • wins (int) – Total wins. Defaults to 0.

  • games_played (int) – Total games player. Defaults to 0.

class asyncpixel.models.players.Legacy(*args, **kwargs)[source]

Legacy games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • total_kills (int) – Total kills. Defaults to 0.

  • total_wins (int) – Total wins. Defaults to 0.

class asyncpixel.models.players.MCGO(*args, **kwargs)[source]

MCGO games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • deaths (int) – Total deaths. Defaults to 0.

  • shots_fired (int) – Total shots fired. Defaults to 0.

  • round_wins (int) – Total round wins. Defaults to 0.

  • bombs_planted (int) – Total bombs planted. Defaults to 0.

  • game_wins_deathmatch (int) – Total games won of deathmatch. Defaults to 0.

  • wins (int) – Total wins. Defaults to 0.

  • kills (int) – Total kills. Defaults to 0.

class asyncpixel.models.players.Paintball(*args, **kwargs)[source]

Paintball games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • deaths (int) – Total deaths. Defaults to 0.

  • wins (int) – Total wins. Defaults to 0.

  • shots_fired (int) – Total shots fired. Defaults to 0.

class asyncpixel.models.players.Pit(*args, **kwargs)[source]

Pit games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • total_kills (int) – Total kills. Defaults to 0.

  • total_wins (int) – Total wins. Defaults to 0.

  • shots_fired (int) – Total shots fired. Defaults to 0.

class asyncpixel.models.players.Quake(*args, **kwargs)[source]

Quake games stats.

Parameters

coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

class asyncpixel.models.players.SkyClash(*args, **kwargs)[source]

SkyClash games stats.

Parameters

card_packs (int) – Card packs. Defaults to 0.

class asyncpixel.models.players.Skywars(*args, **kwargs)[source]

Skywars games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • games_played (int) – Total games played. Defaults to 0.

  • tokens (int) – Number of tokens. Defaults to 0.

  • souls (int) – Souls. Defaults to 0.

  • winstreak (int) – Current winstreak. Defaults to 0.

  • kills (int) – Total kills. Defaults to 0.

  • deaths (int) – Total deaths. Defaults to 0.

  • wins (int) – Total wins Defaults to 0.

  • losses (int) – Total losses. Defaults to 0.

property kills_per_death: float

Kills per deaths.

Returns

ratio between kills and deaths.

Return type

float

property wins_per_lose: float

Wins per losses..

Returns

ratio between wins and losses.

Return type

float

class asyncpixel.models.players.TNTGames(*args, **kwargs)[source]

TNT games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • deaths (int) – Total deaths. Defaults to 0.

  • wins (int) – Total wins. Defaults to 0.

  • record (int) – Record. Defaults to 0.

  • winstreak (int) – Current winstreak. Defaults to 0.

class asyncpixel.models.players.UHC(*args, **kwargs)[source]

UHC games stats.

Parameters

coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

class asyncpixel.models.players.VampireZ(*args, **kwargs)[source]

VampireZ games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • human_deaths (int) – Total deaths as a human. Defaults to 0.

  • vampire_deaths (int) – Total deaths as a vampire. Defaults to 0.

  • zombie_kills (int) – Total kills of a zombie. Defaults to 0.

  • vampire_kills (int) – Total kills of a vampire. Defaults to 0.

  • most_vampire_kills_new (int) – Most Vampire kills Defaults to 0.

class asyncpixel.models.players.Walls(*args, **kwargs)[source]

Walls games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • losses (int) – Games lost. Defaults to 0.

  • deaths (int) – Total deaths. Defaults to 0.

class asyncpixel.models.players.Walls3(*args, **kwargs)[source]

Walls3 games stats.

Parameters
  • coins (int) – Number of coins gathered in this Game Mode. Defaults to 0.

  • losses (int) – Games lost. Defaults to 0.

  • deaths (int) – Total deaths. Defaults to 0.

Utils

Utils.

asyncpixel.utils.calc_player_level(xp)[source]

Calculate player level from xp.

Parameters

xp (int) – amount of xp a player has.

Returns

current level of player.

Return type

float

asyncpixel.utils.get_rank(package_rank, rank=None, prefix_raw=None, monthly_package_rank=None, new_package_rank=None)[source]

Get rank of Hypixel player.

Parameters
  • rank (Optional[str]) – rank

  • prefix_raw (Optional[str]) – raw prefix

  • monthly_package_rank (Optional[str]) – monthly package for mvp++

  • new_package_rank (Optional[str]) – new rank format

  • package_rank (Optional[str]) – old rank format

Returns

rank

Return type

Optional[str]