No description or website provided.
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Documentation update achievements Jan 5, 2019
Example GameCounts endpoint Jan 5, 2019
Java add playerCount to gameCounts Jan 17, 2019
Website Remove Javadocs Dec 23, 2018
.gitignore Javadocs Nov 4, 2014
README.md Happy New Year 🎉 Dec 31, 2018
pom.xml fix examples dependency Dec 23, 2018

README.md

Hypixel Public API (Java)

This is a Java implementation of the Hypixel API

Documentation

Hypixel PublicAPI documentation can be found in the Documentation. Java documentation can be found mostly in the code or JavaDocs.

Usage

You can use this API as a dependency via JitPack. In the future it will be deployed to a public maven repo.

Query Limitations

The API server has a request limit of 120 queries per minute. Abuse of the API will lead to your API key being banned.

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.

Dependencies

The Hypixel PublicAPI has the following dependencies:

  • Google Gson library
  • Guava: Google Core Libraries for Java
  • Apache HttpClient

Bug Reporting

You can create an issue here on GitHub to report a bug with the API or to suggest enhancements.

Copyright

HypixelAPI © 2019

TODO

  • Add a proper copyright header to all files.
  • Deploy to a public maven repo.