Skip to main content

A Python Package to interact with the Hypixel API

Reason this release was yanked:

Hypixel is phasing out player specific api keys, causing this package to be useless

Project description

Hypixel API PY

Hypixel API PY is a Python Package used to interact with the Hypixel API

Current Features:

General Features:
  • Convert between UUID and Username
Player Features:
  • Get Player's First and Last Login Dates as well as their Last Logout Date
  • Get Player's Rank
  • Get Player's Friends
Guild Features:
  • Get Guild By ID, Player or Name
  • Get Guild Members
  • Get Guild Coins and EXP
  • Get Guild Members and Ranks
  • Get Guild Tag and preferred Games
API Key Features:
  • Get Username and UUID from API Key
  • Get API Key Information such as Request Limit, Total Requests and Requests in the last Minute

Usage:

First, go on Hypixel, run the command /api new and save the Key you get in chat.

After that, download the Package using:

pip install hypixel-api-py

Then Import the Package:

import hypixel_api

To connect to the Hypixel API you first need to create a Hypixel Object and initialize it with your API Key:

connection = hypixel_api.Hypixel(your_api_key)

You can verify that your authentication has worked by using the created Player Object:

owner = connection.owner
print(f"Authenticated as {owner.username} ({owner.UUID}) with the key {connection.key}")

To start accessing player data, create a Player Object by using a UUID:

player = hypixel_api.Player(your_uuid)

You can also convert a Username to a UUID:

from hypixel_api.utilities import UUID_from_username
player = hypixel_api.Player(hypixel_api.UUID_from_username(your_username))

After that, call the get_data() Method to obtain Player Data:

player.get_data(connection)

Finally, print out your data:

print(player.rank)

Project details


Download files

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

Source Distribution

hypixel-api-py-0.0.0.0.1.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hypixel_api_py-0.0.0.0.1-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file hypixel-api-py-0.0.0.0.1.tar.gz.

File metadata

  • Download URL: hypixel-api-py-0.0.0.0.1.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for hypixel-api-py-0.0.0.0.1.tar.gz
Algorithm Hash digest
SHA256 b36277e3088b53a45a230b9c6a022b7972f48a83da2fb4b7feed56c4587ae657
MD5 a9db47d579851a31ee9ba9dafc86f044
BLAKE2b-256 94d17236c7165d41e3a293a2c93a69a3119e8562b060731ab7ec1d63f222f97e

See more details on using hashes here.

File details

Details for the file hypixel_api_py-0.0.0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for hypixel_api_py-0.0.0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 52a59cd5d428b2f463b2e5421a05ae9c035f99fc60ee7886b74d688631ff201e
MD5 6ab91dd39242b7e01439207e433b25c9
BLAKE2b-256 1c88826b14b783cc17d2cb8d00c1880eae08751332c49e2f90097b579a5dfe65

See more details on using hashes here.

Supported by

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