https://github.com/janasunrise/hypixelio
A Modern Efficient and Easy way of interacting with the Hypixel API!
https://github.com/janasunrise/hypixelio
hacktoberfest hypixel hypixel-api hypixel-stats minecraft pypi python python3
Last synced: 12 months ago
JSON representation
A Modern Efficient and Easy way of interacting with the Hypixel API!
- Host: GitHub
- URL: https://github.com/janasunrise/hypixelio
- Owner: janaSunrise
- License: mit
- Created: 2020-10-18T12:49:50.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-30T14:20:20.000Z (over 1 year ago)
- Last Synced: 2025-04-10T19:47:35.328Z (12 months ago)
- Topics: hacktoberfest, hypixel, hypixel-api, hypixel-stats, minecraft, pypi, python, python3
- Language: Python
- Homepage: https://hypixelio.rtfd.io
- Size: 1.58 MB
- Stars: 16
- Watchers: 1
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
```
__ __ _ __ ________
/ / / /_ ______ (_) _____ / / / _/ __ \
/ /_/ / / / / __ \/ / |/_/ _ \/ / / // / / /
/ __ / /_/ / /_/ / /> __/ / _/ // /_/ /
/_/ /_/\__, / .___/_/_/|_|\___/_/ /___/\____/
/____/_/
```
HypixelIO
A Modern, Efficient and Easy way of interacting with the Hypixel API!
Docs
·
Report a bug
·
Discussions
·
Discord
## ✨ Why choose HypixelIO?
- Modern way of handling requests
- Modern OOP based structure
- Both Async and blocking support
- Simple ratelimit handling and caching
- Elegant design with complete optimization
- Easy to use with a modern and simple design
- Complete API coverage
## 🚀 Installing
**Python 3.7 or above is required!**
```sh
# 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
```
You can also get extra features with this library. Here's how:
```sh
# Use [speedups] to speed up only for async API
python3 -m pip install -U "HypixelIO[speedups]"
```
## Usage
```python
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(name="user's-username")
print(boosters[0].id)
print(friends.friends[0].receiver_id)
```
### Async API usage
```python
import asyncio
from hypixelio import AsyncClient, AsyncConverters
client = AsyncClient(api_key="your-api-key")
# Async function to fetch info
async def fetch_from_hypixel():
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(name="user's-username")
# Safely close the connection
await client.close()
return boosters, friends
# Run the coroutine using `asyncio`
boosters, friends = asyncio.run(fetch_from_hypixel())
print(boosters[0].id)
print(friends.friends[0].receiver_id)
```
**Find more examples [here](https://github.com/janaSunrise/HypixelIO/tree/main/examples)!**
## 📢 Changelog
If you're interested in seeing the **Changelog**, Go [here!](https://github.com/janaSunrise/HypixelIO/blob/main/CHANGELOG.md)
## 🤝 Contributing
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](https://www.conventionalcommits.org/en/v1.0.0-beta.3/) before
making the commit message. You can find our contributing guidelines
[here](https://github.com/janaSunrise/HypixelIO/blob/main/CONTRIBUTING.md)
We have a branch called `dev` containing development code. If you're contributing, Remember to contribute to
`dev` branch, instead of `main`.
## 💬 Get in touch
If you have various suggestions, questions or want to discuss things with our community, Have a look at
[Github discussions](https://github.com/janaSunrise/HypixelIO/discussions) or join our Discord server!
[](https://discord.gg/MKC4qna4Gz)
## 👋 Show your support
Be sure to drop a 🌟 if you like the project!
## ▶ Links
- [Official Documentation](http://hypixelio.rtfd.io/)
- [Raise an Issue](https://github.com/janaSunrise/HypixelIO/issues)
- [Discussions](https://github.com/janaSunrise/HypixelIO/discussions)
- [Hypixel API Documentation](https://api.hypixel.net)
Made by Sunrit Jana with ❤