API Reference

Version Related Info

There is a single way to check the version for this library.

hypixelio.__version__

A string representation of the version. e.g. '0.1.0b1'. This is based off of PEP 440.

Clients

class hypixelio.Client(api_key: Union[str, list])

Client for handling requests, authentication, and usage of the Hypixel API for the end user.

Examples

If you have a single API key, Here’s how to authenticate

>>> import hypixelio
>>> client = hypixelio.Client(api_key="123-456-789")

You can use multiple API keys to authenticate too. (Better option for load balancing)

>>> client = hypixelio.Client(api_key=["123-456", "789-000", "568-908"])

find_guild(guild_name: Optional[str] = None, player_uuid: Optional[str] = None) → FindGuild

Find a guild using the Guild’s name or a Player’s UUID.

Parameters

• guild_name (Optional[str]) – The name of the Guild. Defaults to None.

• player_uuid (Optional[str]) – The UUID of the Player to find his guild. Defaults to None.

Returns

The ID of the guild being find.

Return type

FindGuild

get_boosters() → Boosters

Get the Hypixel coin boosters, and all the info about them.

Returns

The boosters object, with all the info from the API.

Return type

Boosters

get_friends(name: Optional[str] = None, uuid: Optional[str] = None) → Friends

Get the friends, and all their info of specified Hypixel player.

Parameters

• name (Optional[str]) – The Optional string value for the Username of a hypixel player. Defaults to None.

• uuid (Optional[str]) – The UUID of a Certain Hypixel Player. Defaults to None.

Returns

The Friend object with all info from the API.

Return type

Friends

get_games_info() → Games

Get the list of all Hypixel games, and their info.

Returns

The Games object with all the info.

Return type

Games

get_guild(name: Optional[str] = None, uuid: Optional[str] = None, player_uuid: Optional[str] = None) → Guild

Get info about a specific Hypixel guild using the Name, or the Guild’s UUID.

Parameters

• name (Optional[str]) – The Name of the Guild. Defaults to None.

• uuid (Optional[str]) – The ID Of the guild. Defaults to None.

• player_uuid (Optional[str]) – The UUID of the player to get guild using. Defaults to None.

Returns

The Guild object with the info fetched from the API.

Return type

Guild

get_key_info(api_key: Optional[str] = None) → Key

Get info about a specific Hypixel API key.

Parameters

api_key (Optional[str]) – The API key generated in Hypixel server using the /api new command. Defaults to pre-specified keys.

Returns

The Key object created for the API key specified.

Return type

Key

get_leaderboards() → Leaderboard

Get the leaderboard for the Hypixel games with their info.

Returns

The Leaderboard object with all info.

Return type

Leaderboard

get_player(name: Optional[str] = None, uuid: Optional[str] = None) → Player

Get all info about a Hypixel player using his username or his player UUID.

Parameters

• name (Optional[str]) – The Optional string value for the Username. Defaults to None.

• uuid (Optional[str]) – The Optional string value to the UUID. Defaults to None.

Returns

The player object with all the info obtained from the API.

Return type

Player

get_player_recent_games(name: Optional[str] = None, uuid: Optional[str] = None) → RecentGames

Get the recent games played by a Hypixel player using his Username or UUID.

Parameters

• name (Optional[str]) – The Optional string value for the Username. Defaults to None.

• uuid (Optional[str]) – The Optional string Value to the UUID. Defaults to None.

Returns

The recent games for the respective player specified.

Return type

RecentGames

get_player_status(name: Optional[str] = None, uuid: Optional[str] = None) → PlayerStatus

Get the status about a Player using his username or UUID.

Parameters

• name (Optional[str]) – The Optional string value for the Username. Defaults to None.

• uuid (Optional[str]) – The Optional string Value to the UUID. Defaults to None.

Returns

The Player status object consisting of all info from the API.

Return type

PlayerStatus

get_resources_achievements() → dict

get_resources_challenges() → dict

get_resources_guild_achievements() → dict

get_resources_quests() → dict

get_skyblock_active_auctions(page: int = 0) → SkyblockActiveAuction

Get the list of active auctions in skyblock and use the data.

Parameters

page (int) – The skyblock auction page to lookup.

Returns

The active auction model.

Return type

SkyblockActiveAuction

get_skyblock_bazaar() → SkyblockBazaar

Get the skyblock bazaar items

Returns

The bazaar model object representing each produc

Return type

SkyblockBazaar

get_skyblock_collections() → dict

get_skyblock_news() → SkyblockNews

get_skyblock_profile(name: Optional[str] = None, uuid: Optional[str] = None) → SkyblockProfile

Get the skyblock information and profile about a specific user as passed in the requirements.

Parameters

• name (Optional[str]) – The player’s name in Hypixel

• uuid (Optional[str]) – The player’s global UUID

Returns

The skyblock profile model for the specified user.

Return type

SkyblockProfile

get_skyblock_skills() → dict

get_skyblock_user_auctions(name: Optional[str] = None, uuid: Optional[str] = None) → SkyblockUserAuction

Get the skyblock auction info about a specific user.

Parameters

• name (Optional[str]) – The player’s name in Hypixel

• uuid (Optional[str]) – The player’s global UUID

Returns

The skyblock auction model for the user.

Return type

SkyblockUserAuction

get_watchdog_info() → Watchdog

Get all the stats about the Watchdog (Punishment stats) for the last few days/

Returns

The Watchdog object with all the info.

Return type

Watchdog

Converters

class hypixelio.Converters

url = {'name_history': '/user/profiles/{}/names', 'username_to_uuid': '/users/profiles/minecraft/{}', 'uuid_to_username': '/user/profiles/{}/names'}

classmethod username_to_uuid(username: str) → str

This is a method, to convert username in minecraft, for its respective UUID.

Parameters

username (str) – This is the minecraft user, which is passed to this function for the UUID Conversion.

Returns

returns the converted UUID for the respective username.

Return type

str

classmethod uuid_to_username(uuid: str) → str

Method to convert the UUID for your profile to the username for your Minecraft accoun

Parameters

uuid (str) – This is the minecraft UUID, which is passed to this function for the UUID to username Conversion.

Returns

The username for the respective minecraft UUID is returned.

Return type

str

Utility

class hypixelio.Utils

classmethod get_avatar(name: Optional[str] = None, uuid: Optional[str] = None) → str

Get the avatar of the specified player.

Parameters

• name (t.Optional[str]) – The username of the player. Defaults to None.

• uuid (t.Optional[str]) – The UUID of the player. Defaults to None.

Returns

The URL containing the image of the avatar.

Return type

str

classmethod get_body(name: Optional[str] = None, uuid: Optional[str] = None) → str

Get the whole body’s skin of the specified player

Parameters

• name (t.Optional[str]) – The username of the player. Defaults to None.

• uuid (t.Optional[str]) – The UUID of the player. Defaults to None.

Returns

The URL containing the image of the whole body.

Return type

str

classmethod get_head(name: Optional[str] = None, uuid: Optional[str] = None) → str

Get the head skin of the specified player.

Parameters

• name (t.Optional[str]) – The username of the player. Defaults to None.

• uuid (t.Optional[str]) – The UUID of the player. Defaults to None.

Returns

The URL containing the image of the head.

Return type

str

classmethod get_name_history(name: Optional[str] = None, uuid: Optional[str] = None, changed_at: bool = False) → Union[list, dict]

Get the name history with records of a player.

Parameters

• name (t.Optional[str]) – The username of the player. Defaults to None.

• uuid (t.Optional[str]) – The UUID of the player. Defaults to None.

• changed_at (bool) – Toggle to true, if you need when the player changed name. Defaults to False.

Returns

The list or dictionary with the name history and records.

Return type

t.Union[list, dict]

mojang_url = {'name_history': '/user/profiles/{}/names', 'username_to_uuid': '/users/profiles/minecraft/{}', 'uuid_to_username': '/user/profiles/{}/names'}

url = {'avatar': '/avatars/{}', 'body': '/renders/body/{}', 'head': '/renders/head/{}', 'skins': '/skins/{}'}

Async to sync portal