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

Uploaded Source

Built Distribution

pyhypixel-1.2.0-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

Details for the file pyhypixel-1.2.0.tar.gz.

File metadata

  • Download URL: pyhypixel-1.2.0.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.2

File hashes

Hashes for pyhypixel-1.2.0.tar.gz
Algorithm Hash digest
SHA256 bf14b74e9bc3c75a4b48014c39c8999a6d7bdb16e8a9c6b49138f32dc50a1426
MD5 4bea7d896267f72e8d24c237ec3297b2
BLAKE2b-256 97456fdf08b9f01144542ebdff1bb6e2c7f993fb7cb06eb2b21c301280d431e0

See more details on using hashes here.

File details

Details for the file pyhypixel-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: pyhypixel-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 22.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.2

File hashes

Hashes for pyhypixel-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6ffabd277c5473cbea6e70131448bf70f1c47a871fbbf347a72ee02cdb482a93
MD5 598bfcb8eeac9c8cf8804113e806ff69
BLAKE2b-256 f4d023d4982bd785a99f1c54de132c5770c2227fbc2dd93ec2320a16b91ee358

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