Skip to main content
PyPI downloads PyPI version info License Documentation Status

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

The purpose of this project is to simplify the task of writing scripts that interact with the Hypixel API by converting responses into organized python models and abstracting requests into asynchronous functions, while also offering customization options and useful features.

  • Blazing fast (for python) — Prioritizes speed and efficiency by using built in libraries to achieve asynchronous timed caching, quick nested dataclass sterilization, and modern rate limit handling.

  • 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 and coverage documentation.

Getting Started

Check out the examples and documentation!

Python 3.8+ is required (3.10.8+ recommended)

Installation

To install hypixel.py, install it from pypi under the name hypixel.py with pip or your favorite package manager.

pip install hypixel.py --upgrade

You can append [speed] to install optional packages (see below) to improve the performance of aiohttp and json. Warning: cchardet does not support python 3.10+ and subsequently will not be installed using [speed] if you’re on 3.10 or higher.

pip install hypixel.py[speed] --upgrade

Optional Packages

To ehnahce aiohttp performance:

To enhance json decoding (up to 4x faster):

Warning

If you are running a Python version older than 3.10.8 on Windows, you must run the following code before calling asyncio.run:

# This is because of a bug in the Windows Proactor Event Loop Policy
# which is the default on Windows.
asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())

Quick Example

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())

You can find more examples in the documentation

Metadata

Release files for hypixel.py 0.4.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hypixel.py 0.4.2
File Size Uploaded
hypixel.py-0.4.2.tar.gz 40.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hypixel.py 0.4.2
File Interpreter ABI Platform
hypixel.py-0.4.2-py3-none-any.whl Python 3 none any Details

Total release size: 88.0 kB

Release files / hypixel.py-0.4.2.tar.gz

Download URL hypixel.py-0.4.2.tar.gz
Size 40.9 kB
Tags Source
SHA-256 checksum
How to use checksums
4c13f98c3fbe82b87c2a4f214a752bea8cf73191b09a706ba8f68a2daca49146
BLAKE2b-256 checksum
How to use checksums
3eb2560b1ccc5c8324e78d610aeb54685f1501a4c14f473f741c3db194dc0a02
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.3

Release files / hypixel.py-0.4.2-py3-none-any.whl

Download URL hypixel.py-0.4.2-py3-none-any.whl
Size 47.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8803d381d5b19fc2faf8c93e59c1370681a4dc8673ceedd82023fe891398eb61
BLAKE2b-256 checksum
How to use checksums
a59b574d0960d32218fe0294afe66e8cf9fcab2816257df40d7dfa6920d3889a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.3

Release history Release notifications | RSS feed

This release

0.4.2 This release

2 release files

0.4.1

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page