Introduction

Welcome to the hypple API.

API provides data of player stats and game stats. In the future there might be more data added to the API. You can use the API for any kind of display of data as long as you're not breaking any of the rules.

You shouldn't try to break/exploit the API in any way.

Make sure to check limitations and not exceed them.

Limitations

Each API user is limited to how many requests they can make per minute. Right now you can make up to 50 requests per IP. If you exceed the amount you'll get rate limited and will get a rate limit response.

In the future we might change the limit or implement keys to the API.

If you need to know how many more requests you can make in a minute you can use the following request.

This request does not count in the total of the general requests made.

GET

https://api.hypple.net/rate/info

200

  • {
    • "ip":"78.110.166.82",
    • "requests-left":"103",
    • "requests-max":"200"
  • }

409

  • {
    • "error":"Server error. Unable to access the API."
  • }

Player Data

Player Data is information of a specific player or multiple players.

To get the players general data by uuid or name send the following request.

GET

https://api.hypple.net/player/data?uuid=cdc3cd47-5a3a-4e0c-9476-c70429d2e315

Note when using the name if the player changed it the name will only be updated when the player joins the network.

GET

https://api.hypple.net/player/data?name=alandioda

200

  • {
    • "name":"alandioda",
    • "uuid":"cdc3cd47-5a3a-4e0c-9476-c70429d2e315",
    • "joined-date":"2018-08-08 12:00:00",
    • "last-online":"2021-11-07 20:01:08",
    • "seconds-online":"7094916"
  • }

400

  • {
    • "error":"Incorrect use of the API."
  • }

403

  • {
    • "error":"Missing fields in the request."
  • }

404

  • {
    • "error":"Not in database."
  • }

429

  • {
    • "error":"Rate limit. You exceeded the API requests limit."
  • }

To get the players game data by uuid or name send the following request.

GET

https://api.hypple.net/player/data/games?uuid=cdc3cd47-5a3a-4e0c-9476-c70429d2e315&game=SleepWars

Note when using the name if the player changed it the name will only be updated when the player joins the network.

GET

https://api.hypple.net/player/data/games?name=alandioda&game=All

200

  • {
    • "uuid":"cdc3cd47-5a3a-4e0c-9476-c70429d2e315",
    • "SleepWars":{
      • "games-played":89,
      • "win-streak":0,
      • "deaths":115,
      • "kills":126,
      • "beds-broken":56,
      • "beds-slept":11,
      • "score":547
    • }
  • }

200

  • {
    • "name":"alandioda",
    • "games":[
      • {
        • "name":"SleepWars",
        • "games-played":89,
        • "win-streak":0,
        • "deaths":115,
        • "kills":126,
        • "beds-broken":56,
        • "beds-slept":11,
        • "score":547
      • },
      • {
        • "name":"RainbowParty",
        • "games-played":72,
        • "win-streak":2,
        • "total-wins":40,
        • "score":1197
      • },
      • {
        • "name":"BowlingParty",
        • "games-played":19,
        • "win-streak":0,
        • "total-wins":11,
        • "score":3121
      • }
    • ]
  • }

400

  • {
    • "error":"Incorrect use of the API."
  • }

403

  • {
    • "error":"Missing fields in the request."
  • }

404

  • {
    • "error":"Not in database."
  • }

429

  • {
    • "error":"Rate limit. You exceeded the API requests limit."
  • }

(When achievements and pets get fully added there will be more options for that)

Game Data

Game Data is information of a specific game or multiple games on the network.

To get the list of games send the following request.

GET

https://api.hypple.net/games/data

200

  • {
    • "games":[
      • "sleepwars",
      • "rainbowparty",
      • "bowlingparty",
      • "activewarfare",
      • "golfparty"
    • ]
  • }

429

  • {
    • "error":"Rate limit. You exceeded the API requests limit."
  • }

To get the details of a specific game send the following request.

GET

https://api.hypple.net/games/data?game=sleepwars

200

  • {
    • "game":{
      • "name":"Sleep Wars",
      • "released":"2021-8-11",
      • "id":0,
      • "image":"https://hypple.net/images/covers/mini/sw_s.png",
      • "video":"https://www.youtube.com/watch?v=C5Bf32Zl9PU",
      • "description":"Sleep wars is a variation of the well-known game called Bed Wars with the main change that you can sleep in beds. The goal of the game is to be the last team standing. You can achieve this by destroying all of the other beds and killing all of the other teams. The bed function as a respawn device, if you lose your bed you won't be able to respawn anymore. At the beginning of the game, you'll spawn on one of the side islands with your bed, gold and iron generators, and shop and upgrade trading stations. Iron and gold ingots are used to buy items from the shop. On the map, there are also 2 more generators, diamond and emerald. Diamond generators are on the sides of the islands, which are used to upgrade your gear. You can upgrade your weapons, armor, item generators, movement speed, and mining speed. All of the upgrades only apply for your team. Emerald generators are on the center of the map and are used mainly for more valuable items in the game. By default, you don't spawn with any items. Armor is the only item that stays with you even after you die. When you respawn you have 5 seconds of pvp protection.",
      • "data":{
        • "min-solo":2,
        • "min-double":4,
        • "min-triple":3,
        • "min-quadruple":4,
        • "max-solo":8,
        • "max-double":16,
        • "max-triple":12,
        • "max-quadruple":16,
        • "duration":40
      • }
    • }
  • }

400

  • {
    • "error":"Incorrect use of the API."
  • }

429

  • {
    • "error":"Rate limit. You exceeded the API requests limit."
  • }

To get the list of top players of a game send the following request.

GET

https://api.hypple.net/player/top/games?game=SleepWars&limit=3

200

  • {
    • "1":{
      • "name":"alandioda",
      • "uuid":"cdc3cd47-5a3a-4e0c-9476-c70429d2e315",
      • "score":547
    • },
    • "2":{
      • "name":"UnknownTDO",
      • "uuid":"4e78f0ad-e34f-44ec-abc0-2fb79bdc9be5",
      • "score":170
    • },
    • "3":{
      • "name":"Ananas4k",
      • "uuid":"972b654e-e1a3-4a5d-9cb8-e7eb74401912",
      • "score":157
    • }
  • }

403

  • {
    • "error":"Unknown game."
  • }

429

  • {
    • "error":"Rate limit. You exceeded the API requests limit."
  • }