> ## Documentation Index
> Fetch the complete documentation index at: https://docs.opai.today/llms.txt
> Use this file to discover all available pages before exploring further.

# Hypixel API Key

> How to generate your Hypixel API Key and use it in the Stats module

For cost reasons, the latest version of the **Stats** module no longer uses a shared API.\
Instead, users must set up their own API Key.

You can generate a free API Key (valid for 1 day) from the **Hypixel Developer Dashboard**.

Use the following command to set your API Key:

```bash theme={null}
.apikey <your API Key>
```

Your API Key is stored in a separate file and will not be leaked when sharing configurations.

## Generate an API Key

<Steps>
  <Step title="Register an account">
    Go to the [Hypixel Forums](https://hypixel.net/register/) and create an account.\
    Complete email verification.
  </Step>

  <Step title="Link your Minecraft account">
    Use an unused alt or your main account — make sure the account is **not banned or muted**.\
    If the linked account is banned or muted, the API Key will also be invalid.
    In the Alt Manager, you can right-click an account and click `Copy link code` to quickly obtain the link code (equivalent to join `forum.hypixel.net`).

    <img src="https://mintcdn.com/opai/w5-RtbGvg4_Fy43f/images/copy.png?fit=max&auto=format&n=w5-RtbGvg4_Fy43f&q=85&s=f2922e00121dc5be4ad86b6753969413" alt="copy" width="712" height="395" data-path="images/copy.png" />

    After obtaining the code, go to the [Link Account page](https://hypixel.net/link-minecraft/), paste the code at the bottom, and click **Link account**.
  </Step>

  <Step title="Generate an API Key">
    Go [Hypixel Developer Dashboard](https://developer.hypixel.net/), log in with your forum account, and click **Create API Key**.\
    This generates a temporary API Key (valid for 1 day).

    <img src="https://mintcdn.com/opai/w5-RtbGvg4_Fy43f/images/apikey.png?fit=max&auto=format&n=w5-RtbGvg4_Fy43f&q=85&s=eba30ac715f8490285196b6bc0d2b48b" alt="api" width="754" height="302" data-path="images/apikey.png" />

    Once created, use the command shown above to set your API Key and start using the Stats module.\
    In the future, simply visit the developer panel and click the button again to obtain a new API Key.
  </Step>
</Steps>
