Voxyl Network API


To get access to the API, first you need an API key.

To create a new API key use /api new. To see an existing key use /api get

This api key also allows specific information to that player.



REST API

The API is a simple REST API. All endpoints return JSON.


1. Player info

These are all the calls for player info.

1.1. Basic Info get api.voxyl.net/player/info/[uuid]
Path
uuid The UUID of the player.
Parameters
api Your API key.
Returns
lastLoginName The last name of the player.
lastLoginTime The last login time of the player, UNIX timecode in seconds.
role The rank or role of the player.

1.2. Overall Stats get api.voxyl.net/player/stats/overall/[uuid]
Path
uuid The UUID of the player.
Parameters
api Your API key.
Returns
level The level of the player.
exp The current experience for that level.
weightedwins Player's total weighted wins

1.3. Game Stats get api.voxyl.net/player/stats/game/[uuid]
Path
uuid The UUID of the player.
Parameters
api Your API key.
Returns
stats Key-value map of games.
stats[][wins] The number of games won.
stats[][kills] The kills in this specific game type.
stats[][beds] The total number of beds broken in the game if applicable.
stats[][finals] The total number of finals

2. Guild info

Information about guilds.

2.1. Guild Info get api.voxyl.net/guild/info/[tag]
Path
tag The tag of the guild
Parameters
api Your API key.
Returns
id The ID of the guild. Used internally.
name The name of the guild.
desc The description of the guild.
xp Total guild XP.
num The number of members.
ownerUUID The UUID of the owner.
time UNIX timestamp in seconds of the creation date.

2.2. Guild Members get api.voxyl.net/guild/members/[tag | -id]
Path
tag The tag of the guild.
id The ID of the guild. An alternative option (Use - prefix)
Parameters
api Your API key.
Returns
members An array containing all members in the guild.
members[][role] The guild role OWNER, ADMIN, MODERATOR, or MEMBER.
members[][uuid] The UUID of the member.
members[][time] The join time (UNIX timestamp seconds).

2.3. Top Guilds get api.voxyl.net/guild/top
Parameters
api Your API key.
num The top number to return. A maximum of 100.
Returns
guilds An array of guilds ordered by XP
guild[][placing] From 1, the placing of the guild.
guild[][id] The guild ID.
guild[][tag] The guild tag.
guild[][name] The name of the guild.
guild[][xp] The XP of the guild.

3. Announcements

View current announcements. This is viewable ingame with the books.

3.1. Get All Announcements get api.voxyl.net/announcement/all
Parameters
api Your API key.
Returns
id The ID of the announcement.
title The title of the announcement.
author The UUID of the author.
time A UNIX timestamp in seconds of the publish time.

4. Leaderboards

View the leaderboards.

3.1. Get Normal Leaderboard get api.voxyl.net/leaderboard/normal
Parameters
api Your API key.
type The type of leaderboard: weightedwins or level.
num The number of rows to retrieve, max of 100.
Returns
players An array of players ordered by the type provided.
players[][position] From 1, the position of the player on the leaderboard.
players[][uuid] The UUID of the player.
players[][weightedwins] The number of weighted wins.
players[][level] The level of the player.

3.2. Get Technique Leaderboard get api.voxyl.net/leaderboard/technique
Parameters
api Your API key.
technique The technique type, do /techniquelist in game to view all.
Returns
players An array of players ordered by the type provided.
players[][position] From 1, the position of the player on the leaderboard.
players[][uuid] The UUID of the player.
players[][time] The time in milliseconds for the record.
players[][submittime] The submit time as a UNIX timestamp.