Skip to content

Latest commit

 

History

History
28 lines (20 loc) · 2 KB

File metadata and controls

28 lines (20 loc) · 2 KB

Documentation

Documentation for this API is a Work in Progress. Until then, hopefully exploring the endpoints yourself is self explanatory. Otherwise, feel free to reach out via discord: @stuffy.

Usage

This API can be used by any projects or mods that may have use for any of it's data. Endpoints are formatted as json objects. See table below for endpoints.

Endpoint Link Description
Stuffy Bot Statistics bot Stats for the operation of Stuffy Bot, total commands run, etc.
Hypixel Tournaments tournaments Data on all historical hypixel tournaments, start and end times in Unix, and json objects for where stats are located in the Hypixel API
Play Commands playcommands All known play commands and aliases for Hypixel, constantly updating. Can also be used as a more complete resources endpoint than Hypixel's
Lobby Commands lobbies All known lobby commands and aliases for Hypixel, constantly updating.

Contributing

Note that not all endpoints will accept contributions. Endpoints whose contributions will be considered are the following:

  • tournaments
  • playcommands
  • lobbies

To contribute data to endpoints that support it, make a Pull Request and provide sufficient evidence.

If you notice information missing and are unable to submit a pull request, create a new issue on the Issues page with as much information from the following list as you can provide:

  1. Where information is missing from
  2. What information is missing
  3. The date and time of when you last confirmed this information to be missing