https://github.com/HypixelDev/PublicAPI

Official Java implementation of the Hypixel Public API.
https://github.com/HypixelDev/PublicAPI

api hypixel java minecraft

Last synced: about 2 months ago
JSON representation

Official Java implementation of the Hypixel Public API.

• Host: GitHub
• URL: https://github.com/HypixelDev/PublicAPI
• Owner: HypixelDev
• License: mit
• Created: 2014-10-26T22:20:48.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-07-18T11:25:23.000Z (6 months ago)
• Last Synced: 2024-08-02T17:31:52.051Z (5 months ago)
• Topics: api, hypixel, java, minecraft
• Language: Java
• Homepage: https://api.hypixel.net
• Size: 874 KB
• Stars: 534
• Watchers: 59
• Forks: 152
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Hypixel Public API (Java)

======

[![Maven Package](https://github.com/HypixelDev/PublicAPI/actions/workflows/maven.yml/badge.svg)](https://github.com/HypixelDev/PublicAPI/actions/workflows/maven.yml)

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

GitHub [Discussions](https://github.com/HypixelDev/PublicAPI/discussions).

### Documentation

Hypixel Public API documentation can be found at [https://api.hypixel.net/](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](https://hypixel.net/forums/code-creations.65/) forum.

### Usage

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

the [Example Code](https://github.com/HypixelDev/PublicAPI/tree/master/hypixel-api-example) as a good starting point.

#### Hypixel Maven Repo

```xml

    Hypixel

    https://repo.hypixel.net/repository/Hypixel/

```

This repo can also be used with Gradle.

```gradle

repositories {

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

}

```

#### Transports

We include three built-in options for communicating with the Hypixel API, you can include either of these or even

include the core API directly and create your own instance of HypixelHTTPClient.

* [Apache HttpClient Transport](hypixel-api-transport-apache/README.md)

* [Unirest Java Transport](hypixel-api-transport-unirest/README.md)

* [Project Reactor Transport](hypixel-api-transport-reactor/README.md) (automatic rate-limiting by default)

### Dependencies

The Hypixel API Core implementation has the following dependencies:

* [Google Gson library - 2.10.1](https://mvnrepository.com/artifact/com.google.code.gson/gson)

Transports will also have dependencies where required.

### 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.