Skip to main content

An API wrapper for the Hypixel API

Project description

hypixelaPY - Hypixel API wrapper written in Python

widget

Maintained by Myer (also known as myerfire, MyerFire)

This library is an async wrapper for the Hypixel API. It also contains some features and wrappers on relevant features of the Mojang API and session server.

Features

  • Getting a player from Hypixel from UUID, name, or an unknown source (will try to interpret as UUID first, then name)
    • Names will always be converted to a UUID using the Mojang API
  • Getting a player's name history from Mojang from UUID
  • Getting the official Hypixel leaderboards

Installation

hypixelaPY is available from the official pYpI package index.

python -m pip install -U hypixelaPY

Documentation

See docs.md

Quick Start

from hypixelaPY import Hypixel
import asyncio

API_KEY = "hahagetbaited"
# if it isn't obvious enough, replace this string 
# with your API key obtained by running /api new on Hypixel

async def main():
    hypixel = await Hypixel(API_KEY)
    player = await hypixel.player.get(name="Technoblade")
    print(f"[{player.rank.name}] {player.name}")

if __name__ == "__main__":
    asyncio.get_event_loop().run_until_complete(main())

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hypixelaPY-1.4.4.tar.gz (13.3 kB view hashes)

Uploaded Source

Built Distribution

hypixelaPY-1.4.4-py3-none-any.whl (24.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page