Asyncpixel

Easily access Hypixel's api

Asyncpixel is an open source asynchronous python wrapper for the Hypixel api with 100% of all endpoints.

🤖 🎨 🚀

Docs · Feature request · Report a bug · Support: Discussions

✨ Features

• Asyncronous. Unlike other libraries Asyncpixel is fully asynchronous. This makes it perfect to use in your next discord bot or powerful website without having to worry about blocking.

• 100% API coverage. Asyncpixel is currently the only python library with full coverage of the Hypixel API meaning that no endpoints are left untouched and out of your reach.

• Pydantic models. All models are checked and validated by Pydantic meaning that the data is always in the correct format perfect for you to use.

• Available on pypi. Asyncpixel is available on pypi meaning no building from source, just use pip install asyncpixel to use it in your project.

🏁 Getting Started with Asyncpixel

To get started check out the documentation which lives here and is generously hosted by readthedocs.

Installation

Use the package manager pip or your favourite tool to install asyncpixel.

pip install asyncpixel

Example

import asyncpixel
import asyncio

async def main():
  hypixel = asyncpixel.Hypixel("hypixel_api_key")
  player = await hypixel.player("405dcf08b80f4e23b97d943ad93d14fd")
  print(player.stats.bedwars)
  await hypixel.close()


asyncio.run(main())

❗ Code of Conduct

Darkflame72 is dedicated to providing a welcoming, diverse, and harassment-free experience for everyone. We expect everyone in the Darkflame72 community to abide by our Code of Conduct. Please read it.

🙌 Contributing to Asyncpixel

From opening a bug report to creating a pull request: every contribution is appreciated and welcomed. If you are planning to implement a new feature or change the library please create an issue first. This way we can ensure your work is not in vain.

Not Sure Where to Start?

A good place to start contributing, are the Good first issues.

📝 License

Asyncpixel is open-source. The library is licensed GPL v3.

💬 Get in touch

If you have a question or would like to talk with other Asyncpixel users, please hop over to Github discussions.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

AjayACST 🚧

Alex 💻 🐛

Damian Grzanka 💻

satyamedh hulyalkar 🐛

dubs 🐛

Amund Eggen Svandal 💻 🐛

wald0040 🐛

This project follows the all-contributors specification. Contributions of any kind are welcome!