This API was originally made by Altpapier and MattTheCuber, huge credits
to them.
Support them by subscribing to
Patreon
The Qwack API uses their own API keys to authenticate requests.
You can either use the key query parameter by adding a
?key=token to the end of API requests or using an
authorization header by adding a Authorization header to
your API requests, where the value of the header is your API token.
All endpoints in the API return all their responses in JSON, all
requests will return a status key which should match the
response status code that was returned and a data key for
successful responses. A reason key will be returned for
failed requests.
| Status Code | Reason |
|---|---|
| 102 | Processing |
| 200 | Successful request |
| 400 |
The request is missing an authentication method (valid
key query parameter or an
Authentication header)
|
| 403 | The provided token does not exist |
| 404 | There is no player with the given UUID or name or the player has no Skyblock profiles |
| 429 |
The Hypixel API rate-limit was reached (The API will return
RateLimit-Remaining and
RateLimit-Reset headers)
|
| 500 | There was an error in the Qwack API or the Hypixel API returned an unknown error code. Please report these errors back on GitHub |
| 502 | Hypixels API is experiencing some technical issues or is unavailable |
| 503 | Hypixels API is in maintenance mode |
| 504 | Hypixels API returned a Gateway Time-out error |
GET /v1/profiles/:userGET /v1/profile/:user/:profileGET /v1/items/:userGET /v1/items/:user/:profileGET /v1/auctions/:userGET/v1/auctionhouse/:name/:lore/:rarity/:category/:bin/:lowest_price/:higehst_price/:userGET /v1/bingo/:userGET /v1/calendarGET /v1/fetchurGET /v2/networth/:user/:profileGET /v2/profiles/:userGET /v2/profile/:user/:profile| Parameter | Description |
|---|---|
| user | This can be the UUID of a user or the name |
| profile | This can be the users profile id or name |
| name | Name of the desired item |
| lore | Lore of the desired item |
| rarity | Rarity of the desired item |
| category | Category of the desired item |
| bin | Should the auction be BIN or Auction, boolean |
| lowest_price | Lowest price of the desired item |
| highest_price | Highest price of the desired item |
| Feature | Description | Endpoint |
|---|---|---|
| auctions | Get a player's active and ended auctions and information about them | auctions |
| auctionhouse | Get currently active auctions and details about them | auctionhouse |
| bingo | Get a player's bingo profile and progress | bingo |
| calendar | Get Skyblock's calendar including all events | calendar |
| items | Check what item fetchur wants today including description of the item | fetchur |
| skills | Get a player's skills | profile/profiles |
| networth | Get a player's networth including all information about the calculation | profile/profiles |
| weight | Get a player's Senither and Lily weight | profile/profiles |
| dungeons | Get a player's dungeons stats | profile/profiles |
| bestiary | Get a player's bestiary | profile/profiles |
| crimson | Get player's Crimson Isle data | profile/profiles |
| trophy_fish | Get player's trophy fishing caches and information | profile/profiles |
| enchanting | Get a player's enchanting stats including experimentations | profile/profiles |
| farming | Get a player's farming stats including Jacob's contests | profile/profiles |
| mining | Get a player's mining stats including HotM tree and forge | profile/profiles |
| slayer | Get a player's slayer stats | profile/profiles |
| milestones | Get a player's pet milestones (rock / dolphin) | profile/profiles |
| missing | Get a player's missing talismans including their price | profile/profiles |
| kills | Get a player's most killed mobs | profile/profiles |
| deaths | Get a player's deaths | profile/profiles |
| armor | Get a player's armor | profile/profiles/items |
| equipment | Get a player's equipment | profile/profiles/items |
| pets | Get a player's pets | profile/profiles |
| talismans | Get a player's talismans | profile/profiles |
| collections | Get a player's collections | profile/profiles |
| minions | Get a player's minions | profile/profiles |
| cakebag | Get a player's new year cake editions | profile/profiles |
| backpack | Get player's backpacks | items |
| quiver | Get player's quiver | items |
| talisman bag | Get player's talisman bag | items |
| backpack icons | Get data about player's backpacks | items |
| ender chest | Get player's ender chest | items |
| potion bag | Get player's potion bag | items |
| fishing bag | Get player's fishing bag | items |
| personal vault | Get player's personal vault | items |
| inventory | Get player's inventory | items |
| candy bag | Get player's candy bag | items |
Examples can be found in the examples folder
here.
This API has been made possible by Altpapier, MattTheCuber, Hypixel Skyblock Facade, SkyCrypt and MaroAPI and a lot of the code comes from them. Make sure to check them out!