Skip to main content

A Python 3 wrapper for the HypixelAPI

Project description

hypixelapi

This is an unofficial Python3 wrapper for the Hypixel API inspired by Snuggle's hypixel.py.

Documentation

Documentation is available here: https://hypixelapi.readthedocs.io/

For the types of JSON received by each command, please reference [this official documentation[(https://github.com/HypixelDev/PublicAPI/tree/master/Documentation/methods)], or print the JSON response to view it yourself.

Installation

To install run:

pip install hypixelapi

Getting Started

First, run /api on the Hypixel server to get your own key.

``from hypixelapi import HypixelAPI

api = HypixelAPI('your-key-here') response = api.get_player_json('uuid') print(response) ``

For more detailed documentation and available functions, visit: https://hypixelapi.readthedocs.io/

Examples

Various examples are available in the examples folder.

These currently include basic player and some of the Skyblock functions, with more to be added soon.

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

hypixelapi-0.1.0.tar.gz (1.9 kB view details)

Uploaded Source

File details

Details for the file hypixelapi-0.1.0.tar.gz.

File metadata

  • Download URL: hypixelapi-0.1.0.tar.gz
  • Upload date:
  • Size: 1.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.1

File hashes

Hashes for hypixelapi-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5f75877ca2a993433d9647cdef477cc547bc67fa6a0cd20698771c56c14f11ab
MD5 c59377df8ad130d083fdf95a99d8ce66
BLAKE2b-256 c5fe562a53730d786fc3e679ce3af0dd0eb46c4881f3d6e6c01f80830d2d5484

See more details on using hashes here.

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