Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 44 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,45 @@
TODO:<br>
* Add a proper readme<br>
* Add a proper copyright header to all files<br>
* Deploy to a public maven repo<br>
Hypixel Public API (Java)
======

This is a Java implementation of the Hypixel API

Dependencies
---------------------------

The Hypixel PublicAPI has the following dependencies:
- GSON
- Google Collections Libary


Documentation
-------------

Hypixel PublicAPI documentation is mostly contained within the source code and the [example code](https://github.com/HypixelDev/PublicAPI/tree/master/Example/src/main/java/net/hypixel/example)

API Information
---

The Hypixel PublicAPI has a request limit of 60 queries per minute.

API Authentication
---------------

HypixelAPI (C) 2014
Users can obtain API keys via doing /api when they log in. This key *must* be kept secret: any abuse can lead to API access being rescinded.


Bug Reporting
-------------

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


Copyright
-------

HypixelAPI (c) 2014


TODO
-----
* Add a proper copyright header to all files
* Deploy to a public maven repo<br>