Code Monkey home page Code Monkey logo

hyapi's Introduction

HyAPI

HyAPI is a better version of the Hypixel API.
This API was made for getting data from the Hypixel API easier and faster.

๐Ÿ‘‰ Wanna help?

Hi! Reformatting is a lot of work so I decided to allow others to help me. If you hate having free time or just wanna help, head over to the Formatting Guide to help me out!

๐Ÿ’ก List of Features

This API has several features that make it better than the Hypixel API ๐Ÿ‘‡

โšก Faster

HyAPI is faster than the Hypixel API because we cache data and return a smaller amount of data. This allows for responses up to 20 times faster!

๐Ÿ“— Easier

HyAPI is easier to use than the Hypixel API because we process the data for you.
Examples of this are things like:

  • Player Rank
  • Network Level
  • No success in the response allows you to use the response data without formatting
  • Ratios
    • Win Lose Ratio
    • Final Kill Death Ratio
    • Kill Death Ratio
  • Averages
    • Average Kills per Game
    • Average Deaths per Game
    • Average XP per Game
  • Formatting The API automatically removes formatting from things like Pet Name Colour and stores it in an extra variable for ease of access.

๐Ÿ—‘ No Unnecessary Things

The Hypixel API gives a lot of unnecessary data that the average request doesn't need. It just clutters response data.

  • Removed all the levelingRewards
  • Removed the 20 different ways of killing and dying
  • Removed overdetailed Quests data

๐Ÿ›’ Specific Requests

The HyAPI returns just the data you want by using different paths for specific requests.
This allows requests to be made more specific and to deliver data faster!

๐ŸŒ API Reference

The base URL for all requests is:

  https://hyapi.tech/api
All current paths
  /key
  /player
  /paths

๐Ÿ”’ Authentication

The API requires authentication in the form of a key in the request URL.
To check out the API without authentication, use key beta

  &key=<key>

๐Ÿ“– Examples

  GET /player

Requires either uuid or name

Parameter Type Description
uuid string The uudi of the requested player
name string The username of the requested player

Using name won't prevent you from making further requests, unlike the Hypixel API.

๐ŸŽ› Options

Player allows for multiple options. These are disabled by default because it can double or tripple the response time. This is because it requires more requests from the Hypixel API.

  &options=<options>
Option Description
guild Adds the guild object to the response
friends Adds the friend count to the response
Guild Object
"guild": {
        "name": "Bedwars",
        "exp": 69637363,
        "level": 30,
        "description": "Bedwars Go Brrrrr",
        "tag": {
            "text": "BEDWAR",
            "colour": "DARK_GREEN",
            "hex": "#00AA00"
        },
        "member": {
            "rank": "Guild Master",
            "tag": "GM",
            "quests": 1665,
            "joinedAt": 1593624025152,
            "expHistory": {
                "2021-07-06": 0,
                "2021-07-05": 24309,
                "2021-07-04": 7021,
                "2021-07-03": 44410,
                "2021-07-02": 39752,
                "2021-07-01": 0,
                "2021-06-30": 8162
            }
        }
    },

โ“ FAQ

Why isn't path.color working?

I used British English throughout the entire API.
This means words as color will be colour and soccer will be football.

Dictionary
American British
color colour
soccer football

โ„น Project Information

Server: NodeJS with ExpressJS
Host: DigitalOcean

๐Ÿ’ป Developer

hyapi's People

Contributors

lopopylopy avatar mauritswilke avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

lopopylopy

hyapi's Issues

toLowerCase - error

upon entering a tag-less guild

"error": "Cannot read property 'toLowerCase' of undefined"

username / guild to use as an example

guild name: stevecat
username: bb
username: he

error

when entering a username that goes with the ign iiiiiiiiiiii, you get the following error.

"error": "Cannot read property 'IRON_GOLEM' of undefined"

Cannot convert undefined or null to object - error

when you enter a player name like minikloon it'll send an error

"error": "Cannot convert undefined or null to object"

i don't have any major speculations on what this issue could be caused by but i think since he's an admin on hypixel he could have some things removed from the api which returns undefined or null which could possibly be the reason why its returning the error because it has nothing to convert to an object. ยฏ_(ใƒ„)_/ยฏ

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.