__  __            _           __   ________ 
                     / / / /_  ______  (_)  _____  / /  /  _/ __ \
                    / /_/ / / / / __ \/ / |/_/ _ \/ /   / // / / /
                   / __  / /_/ / /_/ / />  </  __/ /  _/ // /_/ / 
                  /_/ /_/\__, / .___/_/_/|_|\___/_/  /___/\____/  
                        /____/_/                                     

• Modern way of handling requests
• Both async and sync support.
• Simple rate handling, and caching.
• Speed optimized
• Easy to use with a modern and simple design
• Full API coverage

Note: Python 3.7 or above is required!

# Windows
py -3 -m pip install -U HypixelIO

# Linux or MacOS
python3 -m pip install -U HypixelIO

# Install the nightly build
python3 -m pip install -U git+https://github.com/janaSunrise/HypixelIO

# Or use [speedups] to speed up only for async features
python3 -m pip install -U "HypixelIO[speedups]"

from hypixelio import Client, Converters

client = Client(api_key="your-api-key")

boosters = client.get_boosters()  # Get the boosters object

friends = client.get_friends(uuid="user's-uuid")  # Returns the Friends object
# or if you don't know the UUID
friends = client.get_friends(uuid=Converters.username_to_uuid("your-username"))

print(boosters[0].ID)
print(friends.FRIENDS[0].RECEIVER_ID)

from hypixelio.ext.asyncio import AsyncClient, AsyncConverters

client = AsyncClient(api_key="your-api-key")

boosters = await client.get_boosters()  # Get the boosters object

friends = await client.get_friends(uuid="user's-uuid")  # Returns the Friends object
# or if you don't know the UUID
friends = await client.get_friends(uuid=Converters.username_to_uuid("your-username"))

print(boosters[0].ID)
print(friends.FRIENDS[0].RECEIVER_ID)

Find more examples here

Contributions, issues and feature requests are welcome. After cloning & setting up project locally, you can just submit a PR to this repo and it will be deployed once it's accepted.

⚠️ It’s good to have descriptive commit messages, or PR titles so that other contributors can understand about your commit or the PR Created. Read conventional commits before making the commit message.

And, Also we have a branch named dev, So if you're interested in contributing, Please contribute to that branch instead of the main branch.

If you have various suggestions, questions or want to discuss things wit our community, Have a look at Github discussions or join our discord server!

If you're interested in seeing the Changelog, Go here!

Be sure to leave a ⭐️ if you like the project!

• Official Documentation
• Raise an Issue
• API-Help section: https://hypixel.net/threads/guide-using-the-hypixel-api-with-python.2596749/

Made by janaSunrise with ❤