-
Notifications
You must be signed in to change notification settings - Fork 22
Hypixel API Keys Guide
The following steps will quickly get you started with using the Hypixel API with Abyss Overlay. If you need detailed steps, read the next section.
- Log in to the Hypixel Developer Dashboard (open in new tab)
- Generate a Development Key
- NOTE: development keys expire every 3 days, but they are the safest option
- Click on the green copy button to the right of the generated key
- Go to overlay and click on the box where it says "Click to paste API key"
- You're done!
IMPORTANT:
Read the API Policy before applying for a Personal API Key. Hypixel prohibits the use of the same key across multiple applications. If you do not comply with their policy, you could be banned from using the API entirely. The safest option is to generate Development Keys as they expire.
Either way, please use your Hypixel API with the overlay at your own risk! We do not have any instances of anyone getting banned for using the overlay yet, but we cannot guarantee/encourage anything.
The Hypixel Developer Dashboard is where you can manage all of your projects and API keys. A Hypixel Forums account is required, so you may need to create one. If you already have an account, click the "Log In" or "Open Dashboard" button. If you don't, follow these steps to create an account:
- Open the account registration page
- Fill out all of the required information. Remember to pick an appropriate username because it will be linked to your Minecraft account, and choose a strong password because it protects sensitive information.
- Verify your email by following the instructions sent to your email
- Link your Minecraft account using one of the two following methods:
- Join the Hypixel Minecraft Server and run the command
/linkaccount. If you click on the link in chat, the Forums website should open and your account will be linked. - If you cannot join the server for some reason, such as being temporarily banned, join the server
forums.hypixel.net. Paste the code that is displayed into the account linking page, and then click "Link account"
- Join the Hypixel Minecraft Server and run the command
- Sign in to the dashboard with the Forums account you just created
The following could be tricky so try it at your own risk! We still recommend sticking to using only Development Keys.
Once you have access to the Developer Dashboard, click on the "Create API Key" button. This will generate a development key and will allow you to apply for a permanent key.
| Development Key | Personal Key | Production Key |
|---|---|---|
| 300 requests/5 minutes | 300 requests/5 minutes | 600 requests/5 minutes |
| Expires after 24 hours | Permanent | Permanent |
| Generated instantly | Requires review | Requires URL and extensive review |
Click on the "Create App" button located at the top-right corner (it will only work if you have an active development key). Select the "Personal" option unless you need the higher rate limit and have a website that you can use for verification. When filling out the details, avoid writing something too generic or something against Hypixel's policy.
After creating the key, make sure to copy it and save it somewhere safe because you won't be able to view it again. If you lose it, you can select the application in the dashboard and click the "Regenerate API Key" button to obtain a new one. If the application gets rejected, try again with a different name and description. Take their feedback with the rejection into account.
To add the key to the overlay, simply open up the overlay settings and scroll down to the "Hypixel API Key" setting. Clear the old key if there is one, then click on the button to paste the new key. You may have to use your development key until your application gets approved.
To reset/remove your API key from the overlay, head to settings and find the Hypixel API Key setting, and then click on the U-turn arrow button ⮌
Guide compiled with love by @CreationNation1 and @Chit