Documentation

class hypixelapi.HypixelAPI(key)

The HypixelAPI class used for calling all functions related to the API.

get_all_skyblock_profiles(uuid)

Retrieves all Skyblock profiles for a single player.

Parameters:uuid – A player’s UUID (either trimmed form or one with dashes)
Returns:A dictionary of all the user’s Skyblock profiles
get_boosters()

Gets full JSON data about boosters

Returns:All current booster information as a dictionary
get_current_skyblock_auctions(page=0)

Gets information about Skyblock’s current auctions

Parameters:page – The page to retrieve (starting from 0, 1000 results on each page)
Returns:Current auction information as a dictionary
get_friends(uuid)

Finds friends of a player.

Parameters:uuid – A player’s UUID (either trimmed form or one with dashes)
Returns:A list of the player’s friends as a dictionary
get_game_counts()

Gets information about the number of players in each gamemode.

Returns:Gamemode’s player counts as a dictionary
get_guild_by_guildid(uuid)

Retrieves guild information by guild ID

Parameters:uuid – A guild UUID
Returns:The guild information as a dictionary
get_guild_by_name(name)

Finds guild information by name

Parameters:name – The name of a guild
Returns:The guild information as a dictionary
get_guild_by_player(uuid)

Retrieves guild information by member UUID

Parameters:uuid – A player’s UUID (either trimmed form or one with dashes)
Returns:The guild information as a dictionary
get_leaderboards()

Gets information about game’s leaderboards.

Returns:Gamemode’s leaderboards as a dictionary
get_player_count()

Returns the total number of players on the server

Returns:Total number of players as a dictionary
get_player_info(uuid)

Gets some basic information about a player.

Parameters:uuid – A player’s UUID (either trimmed form or one with dashes)
Returns:Player’s displayname, uuid, rank and possibly social media and karma.
get_player_json(uuid)

Gets the full JSON of a player by their UUID.

Parameters:uuid – A player’s UUID (either trimmed form or one with dashes)
Returns:Player’s full JSON
get_player_rank(uuid)

Gets rank information about a player.

Parameters:uuid – A player’s UUID (either trimmed form or one with dashes)
Returns:Player’s rank information (including current_rank and underlying_rank) as a dictionary
get_resources(resource_type)

Gets information about static resources

Returns:Resource data as a dictionary
get_session(uuid)

SOON TO BE REMOVED: Gets information about a player’s session.

Parameters:uuid – A player’s UUID (either trimmed form or one with dashes)
Returns:Player’s session information as a dictionary
get_skyblock_auctions_by_auctionid(uuid)

Gets information about a specific auction

Parameters:uuid – A Skyblock auction ID
Returns:Auction information as a dictionary
get_skyblock_auctions_by_player(uuid)

Gets information about a player’s auctions

Parameters:uuid – A player’s UUID (either trimmed form or one with dashes)
Returns:Player’s auction data as a dictionary
get_skyblock_auctions_by_profileid(uuid)

Gets information about a Skyblock profile’s auctions

Parameters:uuid – A Skyblock profile ID
Returns:Profile’s auction information as a dictionary
get_skyblock_news()

Gets Skyblock news

Returns:Skyblock news as a dictionary
get_skyblock_profile_by_profileid(uuid, player_uuid=None)

Retrieves a Skyblock profile

Parameters:
  • uuid – A Skyblock profile UUID
  • player_uuid (str, optional) – A player UUID: only used if a singular player’s data is wanted rather than all the members of the profile.
Returns:

A dictionary of the requested Skyblock profile
get_watchdog_stats()

Gets Watchdog statistics.

Returns:Watchdog statistics as a dictionary
exception hypixelapi.HypixelError

General error when something has gone wrong. Can be caught with except hypixelapi.HypixelError

exception hypixelapi.PlayerNotFoundError

Exception that is thrown when a player isn’t found. Can be caught with except hypixelapi.PlayerNotFoundError