Skip to main content

An unofficial HypixelAPI wrapper

Project description

pyhypixel

This is an unofficial Python3 HypixelAPI wrapper.

Installation

You can simply install the package by using:

python3 -m pip install pyhypixel

Usage

First of all you have to get an api key by using /api while on Hypixel network.

Everything starts with the creation of an api instance:

from hypixelapi import hypixelapi


api = hypixelapi.HypixelAPI('YOUR_HYPIXEL_API_KEY')

You can get a player by using:

player = api.get_player('SonoMichele') # also works with uuid

You can get a guild by using one of three methods:

# first method using guild id
guild_by_id = api.get_guild_by_id('52e57a1c0cf2e250d1cd00f8')

# second method using guild name
guild_by_name = api.get_guild_by_name('The Sloths')

# third method using a player instance
guild_by_player = player.get_guild()

Documentation

A detailed documentation is available here

Contributing

If you want to contribute you can do it by opening an issue or a pull request.

You can also contact me on telegram @sonomichelequellostrano

All contributors will be listed on this repository.

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

pyhypixel-1.2.0.tar.gz (6.9 kB view hashes)

Uploaded Source

Built Distribution

pyhypixel-1.2.0-py3-none-any.whl (22.6 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