-
Notifications
You must be signed in to change notification settings - Fork 2
External Custom Server
Often, we're gonna want data that isn't just from the api.hypixel.net/player endpoint.
The most immediate one would be sniper detection networks, but having it "custom" allows you to do anything, as long as the server speaks the right format.
I run a wrapper for the discord.gg/bwstats sniper network through api.hypixelstats.com/sniper, and plan to expand the functionality in the future.
Responses must be of type application/json
It is recommended that you have an argument ?getConfig available. The full config format can be found through https://api.hypixelstats.com/sniper?getConfig. This will allow users to quickly configure their client to whatever you need, making custom profiles easier (you can distribute under the assumption of a specific reference name), as well as ensuring that they are sending the correct data.
The client can send three regular arguments:
- User (Hypixel) Key (
?key=) - Player name (
?name=) - Player UUID (
?uuid=)
At the moment, these are not configurable.
Other than that, your server has to run through SSL, as the client will only communicate over https.
Hypixel's API isn't consistent, so there's a manual override.
If you set:
- URL:
api.hypixel.net/guild - Sends:
Hypixel Key,Player UUID
It will work, despite the endpoint being wrong.