HypixelDev / PublicAPI

Official Java implementation of the Hypixel Public API.
https://api.hypixel.net
MIT License
533 stars 152 forks source link

[Suggestion] Lightwight and Fast SkyBlock Profile API #537

Closed doej1367 closed 2 years ago

doej1367 commented 2 years ago

Disclaimer: I don't know where the bottlenecks on your servers are and whether the request count or the amount of the processed and sent data is the bigger issue, but I'll put this suggestion out there anyways...

For the information that updates multiple times during the 5 minute cooldown of a normal api request it would be great to have an api that does not need to send a large, and slow 350 KB response which only updates every 5 minutes. A small 5 KB response that updates every 5-20 seconds would be much more usefull in those cases.

Here is an example response to show how such a small and fast response could look like:

{
  "success": true,
  "profile": {
    "profile_id": "0850e2671c8a4e668ec571cae943efdd",
    "members": {
      "0850e2671c8a4e668ec571cae943efdd": {
        "last_save": 1651461120834,
        "lastLogin": 1651460882410,
        "online": true,
        "current_area": "dungeon_hub",
        "wardrobe_equipped_slot": 4,
        "inv_armor": {
          "type": 0,
          "data": "H4sIAAAAAAAAAO2Y328qxxXHh4vtYDs3vkmbpFLUdNum6nVt8M7+ZFFSFRuMcQzYgI2hqujADrD2/qD7wxg/9KUvUaX2qQ9VlfQp0pX6Z9w/5f4hVc/sGhv849qNbq/6EAkBM3PmzNmzcz7fnV1CaBHFjCWE0NwT9MTQY8kYmt9yAtuPLaG4T/qLaI7a3QGziD1BcfPMRPHQEiVQDC0f2h2XklPSMWksjhZ3DJ1um6Tvgfm/l9A7uuENTTIGJ3uOSxPQ+wniXr5QC5S4XK0LfRlo6hhLAvymn0uKrKwiESx2KDH9ARslaxIvwi99vqbwq8z8+ZokrYb2a3hd5XEKC6tIhUk52qO2R6NZoqil5GieGM7TwBzzVxMlkU+ltVX0CUysDSnVo2lKNC4oKTm9in4Gg0Xbp6Zp9CEPl66FKNq1dDoF4X4KDfm3L190X/39W/j3u6vmP/7GmnDRJQj65Qsz+t4jns/VfGLr3BEEtc4iy9GhP4BOF/LncsVicTKwTYk/gK5tAhHYfe4IxpAMAwXXGcGUoyvLfdfxadc3HHuqs0pPgjNqE59yR+jn0FEL+pD5auANplepDxzX9lgPBAtmapXqQZd6HKzN6cQifcqNnYDzySnleq5joR+B0chgoXlcZww+upj/BfSlwMGPX75QtgPT5GrU5zYdO/AyXCO07cAy6CdhvskIFiRc5IOzDJsFTs+oOw4DgNsm8myneLTr2LrHBUPOd2CCRc4NK7DQZ6ERwdxVICmu6QQuN4lqZJhmePt8l5xRM5wNKafnQ9PRKQer2bAJO2O0DDbUppZBPRb9M5ZL6vYgl1Hw6KfhHujCPvcgJbDoq2++4i63GlsefDyNolkTJjmAhdNwr3/F9smWk3SGXM0JzA4Uls5dDiFtsitOycsXLje9R0rN+k5xi8sdlgv5SpnbrFTqNe7aPI7mu47puOirP/0xgebKxKIIfOqTuAuOqTvuLz24AMdnISuvvv7Xfd9oCa3kzyFLWR/2XyfwqRdHKy5xDX/cDoZ9l+iU1TPU97OB47eHjk98p91lkIDulcQkmGUsKhks4gwWlCU016eWl0DLufx2vlwrHuXbPEps72Ube/laLYFWpvrbYIrmqoebzQRKbFVKm9n6rPG7k85rS8BPwnJ0o2dQF70zjC48jj7QA7tPHbtt+NRqm7ChTIhxPoEWHdfoG3ad9NEHtf18PtduFOs7+Wo7zG0iJNr79Wz5y5n+JfQuox+xfYvaPuTlqc4qte1FlQqu43H0g8D0DQtqrG1CacMY7DO2aBwteazc2i6UW2S64IeVFjVWelFxt3tRcUNvAua4VzV76WR4VdnQsQBO+mHtswZkYS4IIPTPeFknmqCKSUFXxKSECU1qRJOSclqX5F6HqCpVYug93WGO9bYVeDSwYpAXCJ1CyNYQPcPCBhY3BJ7TMoLG7ZcQeoIWcmH5I/af6cP6DX34Lhrw4Z0aIApySFWZ5/lV9MUNDVB5bVoDgOWCdEsNxHUeoM7UYO2mGghpdVoLQgXAqpjS5DcF+S8egvxrkc0oM4Pr79l8m82Poernj6bqXr5QKJYLd4KV/r41ASvDdMEABFxjdY/2gSX9t0bWRczjjKZkNP7tcnW+z677cVT9cIaqk9xGYP3hNFgnQ7fYej9HZ7B5C5BTPLxJy/lrQGKeYCLwSlIWcS8pyRJOdgRMk4pCRKJpvCp08GMAqTJAqhmM7wHk2hsA5Ed3AlLGrwWkKj8GkIImpzQA5Pqtx2VJnX1cjh6Sscro9xhCspDrbkC5GbdRyGvg+y0wNPMgQ696WKBTc7+H66Pg+utHw3VrJ1+r7+9l6/m78JrPfj7Ba/Y2XrcGUHBQEj59ALBs7/zzz28MswlFyyhyRvm/ouzCDGU/nqHsdZIjzn40zdnrwf+CtCs+FEZ7hqGxh/h7A7n3PKCqVOumNVFIajKvJyW+IyTTuCMlJUEkkqyqokDVB/i7gjcw3hAw4FcU7sHvX+5/f/Fk9v3FPLpsx6L2ArrN5qXaKdRzZWRTFzJchMvoSbraE3mc7OpCOinKYjeZ5gU1me4qWBVktZNWMMwDtMCZxIfSWkQJn577gUu98CUK7LYjYgY0dkzHuzxpYLMrVged46xROcnj8kl/VLpoiqWT5qh80vSK9ua4I7SGncLRbmurqBRPDs5bufKgaZXGrVyXr9QPRqVCSS7lTket3CFfuqielnIlqXSxbRSNkdHd2T1rWabXOpQHncahUTF2y62GPiDC+VlHkIy9rd0L0tCD5nEVd62jWut4G5PjXZOtpe/s4lZtZOiFI0nfORq3jktGxfaMQ97frRtFBeKHOSPm09F3qqOKkT6bsg06DTNoNcrjZqPF71myqW9pfOt4wOvgf+9i22peZM8ruQO+fFG2WvW+VLIOxpXcKW4Kh2JT2D2p5PJyWdg9Lec2rdZJd9S0muelwsFF+eIAtwqHMFYUmhe7g0qjhFtWSawUmkbvGGuQ5TtV9eOQwDdUVZMjhZJ4QbstqrAv7xVVQbhUSWFdSmspBSRw9aaoYvmmpCqSkBJBC1N3KioOJRWc44lzSVNSeOb88c1EOzVodl59/Vf4x7TzNw9pZ/YPAeGyvR5Ijj/mirckNZTPaT296y3SdZ83NFwSiSecTZ7ePKp8CojOdgwT1spwOcPrB57P3mCx9LLD7vuQgMbAMCk3gjsCPZnwCSLJCefcILIJFZeDwzHngcCBLIeyFlq0HKsDxRVZVCmBYoObOgYFDG9yaJY1TWfkRfrtcJ4Pt5wpIWJy7QWWBZET+Oi6wa6CmOxOCaH0gu55oR/DZk8ChguS2YWVCNwol8U7dOwUk3tYBb4OLzXmMiou61qgJuy9Iu2F72NgeVCmfh8ms0VBnxMwODD8Rwtv5tHCu5PfK+XrU6I7EVrxSmgv81Ui3un/+ARzJaQLTPVmZXGplt3f3ylWmbTObRfL+e989Fiu5rP7oHilbO3LSAine97YOeN1OhdHy+51RUQOnhIouDa5LDiWpWs17PYErBKJJBU9DacRXVCSGmhgUlKpRNOCQIjQhRWJfWaYbZBCFtN7Dx5P+A1B2cAae3/Dc9kZfYwj9B9i/Ix/7RcAAA\u003d\u003d"
        },
        "selected_pet": {
          "type": "BLUE_WHALE",
          "exp": 2.7843641827335875E7,
          "tier": "LEGENDARY",
          "heldItem": "PET_ITEM_SPOOKY_CUPCAKE"
        },
        "selected_dungeon_class": "tank",
        "experience_skill_farming": 1.4972300881726682E7,
        "experience_skill_mining": 7.322126495863782E7,
        "experience_skill_combat": 8.029735431738292E7,
        "experience_skill_foraging": 3743763.284069729,
        "experience_skill_fishing": 1.46280240328444E7,
        "experience_skill_enchanting": 7.509730252196984E7,
        "experience_skill_alchemy": 1.722368912404863E7,
        "sacks_counts_not_zero": {
          "DUNGEON_DECOY": 2021,
          "INFLATABLE_JERRY": 3718,
          "DUNGEON_TRAP": 2069,
          "SPIRIT_LEAP": 1186,
          "RUNE_HEARTS_1": 8,
          "RUNE_SPARKLING_1": 3,
          "RUNE_FIRE_SPIRAL_1": 6,
          "RUNE_GOLDEN_1": 1,
          "RUNE_CLOUDS_1": 2,
          "RUNE_HOT_1": 8,
          "RUNE_WHITE_SPIRAL_1": 3,
          "RUNE_ZAP_1": 4,
          "RUNE_GEM_1": 13,
          "RUNE_LAVA_1": 13,
          "RUNE_SNOW_1": 11,
          "RUNE_BLOOD_2_1": 10,
          "RUNE_LIGHTNING_1": 1,
          "ICE_HUNK": 1041,
          "BLUE_ICE_HUNK": 43,
          "RUNE_WAKE_1": 8,
          "RUNE_SPIRIT_1": 4,
          "STONE": 106,
        }
      }
    }
  }
}