Client#

class asyncpixel.Hypixel(api_key: Optional[Union[str, uuid.UUID]] = None)[source]#

Client class for hypixel wrapper.

await auction_from_player(player: str) Optional[List[asyncpixel.models.auctions.AuctionItem]][source]#

Get auction data from player.

Parameters

player (str) – player.

Returns

list of auction items.

Return type

List[AuctionItem]

await auction_from_profile(profile_id: str) Optional[List[asyncpixel.models.auctions.AuctionItem]][source]#

Get auction data from profile.

Parameters

profile_id (str) – profile id.

Returns

list of auction items.

Return type

List[AuctionItem]

await auction_from_uuid(uuid: Union[str, uuid.UUID]) Optional[List[asyncpixel.models.auctions.AuctionItem]][source]#

Get auction from uuid.

Parameters

uuid (UUID) – minecraft uuid.

Returns

list of auctions.

Return type

List[AuctionItem]

await auctions(page: int = 0, retry: int = 3) asyncpixel.models.auctions.Auction[source]#

Get the auctions available.

Parameters
  • page (int) – 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

await bazaar() asyncpixel.models.bazaar.Bazaar[source]#

Get info of the items in the bazaar.

Returns

object for bazzar.

Return type

Bazaar

await boosters() asyncpixel.models.booster.Boosters[source]#

Get the current online boosters.

Returns

object containing boosters.

Return type

Boosters

await close() None[source]#

Used for safe client cleanup.

await game_count() asyncpixel.models.game_count.GameCounts[source]#

Gets number of players per game.

Returns

game counts.

Return type

GameCounts

await guild_by_id(guild_id: str) Optional[asyncpixel.models.guild.Guild][source]#

Get guild by id.

Parameters

guild_id (str) – id of guild.

Returns

guild object.

Return type

Guild

await guild_by_name(guild_name: str) Optional[asyncpixel.models.guild.Guild][source]#

Get guild by name.

Parameters

guild_name (str) – name of guild.

Returns

guild object.

Return type

Guild

await guild_by_player(player_uuid: Union[str, uuid.UUID]) Optional[asyncpixel.models.guild.Guild][source]#

Get guild by player.

Parameters

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

Returns

guild object.

Return type

Guild

await key_data(key: Optional[str] = None) asyncpixel.models.key.Key[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

await leaderboards() Dict[str, List[asyncpixel.models.leaderboards.Leaderboards]][source]#

Get the current leaderboards.

Returns

raw json response.

Return type

Dict[str, Leaderboards]

await news() List[asyncpixel.models.news.News][source]#

Get current skyblock news.

Returns

List of news objects.

Return type

List[News]

await player(uuid: Union[str, uuid.UUID]) Optional[asyncpixel.models.player.Player][source]#

Get information about a player from their uuid.

Parameters

uuid (UUID) – uuid of player.

Returns

player object.

Return type

Player

await player_count() int[source]#

Get the current amount of players online.

Returns

number of online players.

Return type

int

await player_friends(uuid: Union[str, uuid.UUID]) Optional[List[asyncpixel.models.friends.Friend]][source]#

Get a list of a players friends.

Parameters

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

Returns

returns a list of friend elements.

Return type

List[Friend]

await player_status(uuid: Union[str, uuid.UUID]) Optional[asyncpixel.models.status.Status][source]#

Get current online status about a player.

Parameters

uuid (UUID) – uuid of player.

Returns

Status object of player.

Return type

Status

await profile(profile: str) Optional[asyncpixel.models.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]

await profiles(uuid: Union[str, uuid.UUID]) Optional[Dict[str, asyncpixel.models.profile.Profile]][source]#

Get info on a profile.

Parameters

uuid (UUID) – uuid of player.

Returns

json response.

Return type

Dict[str, Profile]

await recent_games(uuid: Union[str, uuid.UUID]) Optional[List[asyncpixel.models.games.Game]][source]#

Get recent games of a player.

Parameters

uuid (UUID) – uuid of player.

Returns

list of recent games.

Return type

List[Game]

await resources_achievements() Dict[str, Any][source]#

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

await resources_challenges() Dict[str, Any][source]#

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

await resources_guilds_achievements() Dict[str, Any][source]#

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

await resources_guilds_permissions() Dict[str, Any][source]#

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

await resources_quests() Dict[str, Any][source]#

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

await resources_skyblock_collections() Dict[str, Any][source]#

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

await resources_skyblock_skills() Dict[str, Any][source]#

Get the current resources. Does not require api key.

Returns

raw json response.

Return type

Dict[str, Any]

await uuid_from_name(username: str) Optional[uuid.UUID][source]#

Helper method to get uuid from username.

Parameters

username (str) – username of player

Returns

uuid of player

Return type

UUID4

await watchdog_stats() asyncpixel.models.watchdog.WatchDog[source]#

Get current watchdog stats.

Returns

WatchDog stats object.

Return type

WatchDog