Hypixel.py Documentation#

Hypixel.py is a modern, asynchronous, feature-rich, Hypixel API wrapper for Python.

It aims to make the process of writing scripts that deal with the Hypixel API easier to prevent frustration due to the complexity and inapplicability of the API in its current state.

  • Fast AF (for python) — Fast and lightweight by using built in libraries to achieve async timed lru caching, fast nested dataclass json sterilization, modern sane rate limit handling, etc.

  • More asynchronous than online learning — Has full asynchronicity and uses modern pythonic async and await syntax.

  • Cleaner than your room — Uses object oriented pythonic dot syntax for all of its models, so you can easily access any data point without worrying about dictionaries, strings, and any random inconsistencies you may encounter using the raw API.

  • S Tier Docs — Highly maintained documentation with an ample amount of examples to get you started. It also has the highest player model coverage and documentation.

What does it look like? Here’s an example of a simple hypixel.py program:

import hypixel
from hypixel import HypixelException
import asyncio

async def main():
    client = hypixel.Client('api-key')
    async with client:
        try:
            player = await client.player('gamerboy80')
            print(f'[{player.bedwars.level}✫] [{player.rank}] {player.name}')
        except HypixelException as error:
            print(error)

if __name__ == '__main__':
    asyncio.run(main())

If you replace api-key with a valid api key, you’ll get something like this as a result:

>>> [1607✫] [YOUTUBE] gamerboy80

Getting Started#

API Reference#