Skip to main content

A simple wrapper for Hypixel API

Project description

Hypixelpy

Simple wrapper for Hypixel API

WARNING: This is a personal project, bugs and bad performance should be expected. Also, I didn't design this library to be used in large scale. THIS REPOSITORY IS UNDER CONSTRUCTION

Features

Click to see all features!
API:
  ✔️ API Key Information
Player:
  ✔️ Player Data
  ✔️ Player's Friends
  ✔️ Recently Played Games
  ✔️ Player's Status
  ❌ Guild
Resources:
  ✔️ Achievements
  ✔️ Challenges
  ✔️ Quests
  ✔️ Guild Achievements
  ✔️ Guild Permissions
Skyblock:
  ✔️ Collections
  ✔️ Skills
  ✔️ News
  ➖ Auctions by player, profile or UUID
  ✔️ Active Auctions
  ✔️ Recently Ended Auctions
  ✔️ Bazaar
  ✔️ Bazaar Item IDs
  ✔️ Profile by UUID
  ✔️ Player's Profiles
Other:
  ✔️ Active Network Booster
  ✔️ Current Player Counts
  ✔️ Current Leaderboards
  ✔️ Punishment Statistics
Game Types:
  ✔️ IDs
  ✔️ Type Names
  ✔️ Database Names
  ✔️ Clean Names

How to install:

Using pip command:
pip install hypixelpy

From Source Code:
pip install git+https://github.com/cinget/hypixelpy.git#egg=hypixelpy


How to use:

After installing it, run this simple code to see if everything is working:

from hypixelpy.hypixel import Hypixel # importing the library


test = Hypixel(key='PUT YOUR HYPIXEL KEY HERE') # The Hypixel class requires an API key to work
print(test.api.key_information()) # prints all the information from the given key

You should get an output like this:

{
  "success": true,
  "record": {
    "key": "YOUR KEY",
    "owner": "YOUR MINECRAFT UUID",
    "limit": 120,
    "queriesInPastMin": 1,
    "totalQueries": 364
  }
}

Learn more:
Introduction - How it works
How to get an API Key
Check the wiki for more

How to contribute:

Here is some ways to contribute with the project:

  1. Fork this repository
  2. Star this repository
  3. Check the contributing page, if you want to help me to improve this library

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

hypixelpy-0.1.1.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

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

hypixelpy-0.1.1-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file hypixelpy-0.1.1.tar.gz.

File metadata

  • Download URL: hypixelpy-0.1.1.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for hypixelpy-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8f1ea0017aa3fdc8996ab7123b7339eb12b55d3292ba56c0c3cc021eca625170
MD5 9a421c05217f0d5ca5baeb41b35f83fd
BLAKE2b-256 35bb5cd2ec32394b95b6c9bd70200b1e8d397b6ee4060d7ce1de121395ea7900

See more details on using hashes here.

File details

Details for the file hypixelpy-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: hypixelpy-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 21.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.4

File hashes

Hashes for hypixelpy-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 20e7c70f233ad0e994e906ed919bbf8b0aad79942900018c3916d84d7cdf33c7
MD5 adb3115aaf2a1120870669522e1e26fa
BLAKE2b-256 eb5415e03d2aaf320b50dc003fc8adaec086a36dc9f11b0e3642292894b04ccd

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