Endpoints
All endpoints are prefixed with https://pemonlist.com. (e.g. https://pemonlist.com/api/list)
Parameters that start with a : operate as slugs.
Parameters that start with a ? operate as URL parameters.
Versioning
Every endpoint supports a ?version URL parameter. This is commonly used to protect compatibility between versions and prevent breaking changes from actually breaking applications.
The versioning parameter is not required and often does not change the output of an endpoint, but omitting it or including it is not required. If omitted, it defaults to the latest version.
To work properly, the value must be a positive non-zero integer, but no checks are done to confirm this.
API Version per Update Version
v1v1.1.3v2v1.2.0v3v1.2.1-pre.3
Errors
To better handle errors when using the API, all errors will be in a JSON format instead of an HTML page.
Regular error codes don't come with a message key, however fatal_err codes do. These are considered Internal Server Errors and are not directly caused by the requester. They should be reported to the developer immediately.
Every error comes with an error and code key, indicating an error has occured, and what error it is. Endpoint-specific error codes are documented in their respective sections.
General Errors
not_foundThe endpoint you requested could not be found.fatal_errThe endpoint you requested encountered an error.
Uptime
pemonlist.com/api/uptime
Usage
Retrieves the current uptime status of the server.
Response
cachedObjects
The number of query objects currently stored in cache.
cpuUsage
The percentage of CPU used by the process.
memory
The amount of memory used by the process, expressed in KB.
startup
The UNIX timestamp the server was started, expressed in seconds.
uptime
The UNIX time since the server has been started, expressed in seconds.
Explorer
The result will show up here...List
pemonlist.com/api/list
Usage
Returns an array of the current listing of all levels in order of ranking.
Parameters
?page
The current page of results. Defaults to 1.
?limit
The number of results to show per page. Defaults to 10.
Response
count
The number of levels available in the list.
data
creator
The level creator's name.
level_id
The in-game Level ID.
name
The name of the level.
placement
The placement of the level on the list.
top_record
formatted_time
The #1 record's completion time formatted to HH:MM:SS.MS.
player
id
The player's UUID.
name
The player's name.
timestamp_milliseconds
The #1 record's completion time in milliseconds.
verifier
id
The verifier's UUID.
name
The verifier's name.
video_id
The verification's YouTube video ID.
Errors
bad_page
The page is not a positive non-zero integer.
bad_limit
The limit is not a positive integer.
Explorer
The result will show up here...Level
pemonlist.com/api/level/:level_id
Usage
Retrieves a level on the list.
Parameters
:level_id
The in-game Level ID.
Response
creator
The creator of the level's name.
level_id
The in-game Level ID.
name
The name of the level.
placement
The placement of the level on the list.
points
The leaderboard points that the level gives.
records
Record Object
formatted_time
The record's completion time formatted to HH:MM:SS.MS.
mobile
If the record was achieved on a mobile device.
player
id
The player's UUID.
player
The player's name.
rank
The player's rank on the level. Not the same as the player's leaderboard rank.
timestamp_milliseconds
The record's completion time in milliseconds.
video_id
The completion's YouTube video ID or a link to the completion footage on another site.
verifier
id
The verifier's UUID.
name
The verifier's name.
video_id
The verification's YouTube video ID.
Errors
bad_level_id
This ID does not exist in the list's database.
Explorer
The result will show up here...Player
pemonlist.com/api/player/:user
Usage
Retrieves a player on the leaderboard.
Parameters
:user
The player's name or UUID.
Response
device
The device(s) the player uses.
id
The player's UUID.
name
The player's name.
points
The leaderboard points that the player has.
rank
The player's leaderboard rank.
records
Record Object
formatted_time
The record's completion time formatted to HH:MM:SS.MS.
level
level_id
The in-game Level ID.
name
The name of the level.
placement
The placement of the level on the list.
mobile
If the record was achieved on a mobile device.
rank
The player's rank on the level. Does not apply to the leaderboard.
timestamp_milliseconds
The record's completion time in milliseconds.
video_id
The completion's YouTube video ID or a link to the completion footage on another site.
verifications
Verification Object
level
level_id
The in-game Level ID.
name
The name of the level.
placement
The placement of the level on the list.
video_id
The verification's YouTube video ID.
Errors
bad_user
The user does not exist in the list's database.
Explorer
The result will show up here...