Ongenix / Hypixel-Auctions-Wrapper

A simple to use wrapper for Hypixel built in Python

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


hypixel auctions wrapper
A simple to use wrapper for Hypixel built in Python

FeaturesHow To UseDownloadCredits



Features

# Get auction ID's
uuids = x.get_uuid(context=ctx)
# Get auction prices
prices = x.get_prices(context=ctx)
# Get auction names
names = x.get_names(context=ctx, lowercase=True)
# Get auction tiers
tiers = x.get_tiers(context=ctx)
# Check if your item is substandard (cheaper)
substandard = x.substandard_price(context=ctx, item_number=1)

How To Use

# Firstly, import the file
from auctions-wrapper import Hypixel
from os import getenv

# Secondly, define the class (after setting your enviroment variables)
hy = Hypixel(api_key=getenv('KEY'), uuid=getenv('UUID'))

# Thirdly, use the decorator on top of a function.
# You can include the item name (lowercase), Buy It Now (bin), Auctions and tiers
@x.get_auctions(item_name='all', allow_bin=True, allow_auctions=False, allowed_tier='all')
def auctions(ctx):
  # You can find the possible combinations in the features section
  names = x.get_names(context=ctx, lowercase=True)
  print(names)

Download

# Download the repository
$ git clone https://github.com/Ongenix/Hypixel-Auctions-Wrapper/
# Go into the repository
cd Hypixel-Auctions-Wrapper
# Add enviroment variables
$ export [variable_name]=[variable_value]
# Import the wrapper and run your main file
$ python3 'main.py'

Credits

Hypixel.net for their api and Python.org for their amazing language.

Extra notes

You can review the documentation file for more info

About

A simple to use wrapper for Hypixel built in Python


Languages

Language:Python 100.0%