Hypixel API Wrapper - Early Development
Picked up for pattern exercises, not sure how far I'll take this. All name lookups are Minecraft Java Edition accounts.
note: replace vX.X.X with desired library version. Installing from main can including breaking changes.
python -m pip install git+https://github.com/Preocts/hyapi.git@vX.X.X
Uses Mojang's public API to resolve player account data
from hyapi.uuidlookup import UUIDLookup
lookup_client = UUIDLookup()
# Resolve player from UUID
player = lookup_client.resolve_by_uuid("[UUID]")
# Resolve player from displayname (current)
player = lookup_client.reslove_by_name("[DisplayName]")
# Will have values if valid, will be empty strings if not
print(player.id)
print(player.uuid)Uses Hypixel's public API to pull player data. Requires an API key.
Create a .env file in the root directory of your project. In it add the following line with the API key from Hypixel. To get an API key you must log into the Hypixel servers (in game) and type /api in the game chat.
HYAPI_APIKEY=[API KEY]
Alternative: Set an environment variable of the same name
The Player object represents the Hypixel data for a single target player. The .fetch_player(player_id) method will populate the object with Data, Friends, Status, Recent Games, and Guild information. If the provided displayname or UUId is invalid/not found an empty object is returned.
The methods for accessing the information loosely follow the Hypixel public API: https://api.hypixel.net/#tag/Player-Data
Player.fetch_player(player_id: str): Pull all available information from the Hypixel API.data: Various datapoints including displayname, rank, and stats.friends.records: List of Friend objects containing UUIDs of who sent the friend request and who recieved it.status.session: Current status information of the player.games.games: List of Game objects containing the player's recently played games.guild: If the player is in a guild the name and id is provided
All attributes have .raw_data available which contains a Dict[str, Any] of the response from Hypixel API
from hyapi.player import Player
# Create Player instance
uuid = "[UUID or current display name here]"
player = Player()
# Load player by UUID or display name
player.fetch_player(uuid)
# Results will be empty if load fails
print(f"Display name: {player.data.displayname}")
print(f"Current guild: {player.guild.name}")
print(f"Number of friends: {len(player.friends.records)}")
print(f"Currently online: {player.status.session.online}")
print(f"Number of recent games: {len(player.games.games)}")