Hypixel Public API (Java)

This is a Java implementation of the Hypixel API. For discussing the API, requesting help or suggestions you can use the GitHub Discussions.

Documentation

Hypixel Public API documentation can be found at https://api.hypixel.net/. Java documentation can be found in the code.

GitHub Issues

Github issues should only be used to report bugs. Everything else should either be in Github discussions or use the Hypixel Code Creations forum.

Usage

You can use this API as a dependency via the public Hypixel maven repo.

<repository>
    <id>Hypixel</id>
    <url>https://repo.hypixel.net/repository/Hypixel/</url>
</repository>

<dependency>
    <groupId>net.hypixel</groupId>
    <artifactId>HypixelAPI</artifactId>
    <version>3.0.0</version>
</dependency>

This repo can also be used with Gradle in the following form.

repositories {
    maven { url 'https://repo.hypixel.net/repository/Hypixel/' }
}

dependencies {
    implementation 'net.hypixel:HypixelAPI:3.0.0'
}

Dependencies

The Hypixel PublicAPI has the following dependencies:

Google Gson library
Apache HttpClient

Query Limitations

The API server has a request limit of 120 queries per minute. Any abuse of the API or intentions to bypass this limit ( such as with multiple API keys) will lead to your API key being reset or banned.

If you require a higher limit than the above you can open a support ticket at https://support.hypixel.net and provide your use case and why you require a higher limit.

Obtaining an API Key

You can obtain an API key by joining mc.hypixel.net with a valid Minecraft account and running the /api command. You will then be assigned a unique key that is to remain private.

Contributing

When contributing changes to the Java API please provide as much detail on the changes and the reasons for them. We will not accept changes that have no meaningful contribution to the project.

OscarOchoaT / PublicAPI