General API information:
- GET endpoints can be called using POST as well.
- POST endpoints can only be called with POST.
- Replies to requests will always be in JSON and always contains the fields
'result' and 'msg'.
- If a request is successful
'result' is 0 and 'msg' is an empty string. Additional fields will be sent according to the endpoints specification.
- If an error occurs
'result' will be non-zero (error code) and 'msg' contains the error message.
- Some errors may send additional information with the
'data' field, such as on SQL errors. Generally this field is omitted.
Errors:
| 1 | "SQL Error" |
| 2 | "A POST request is required" |
| 3 | "Client ID required" |
| 4 | "Client secret required" |
| 5 | "Invalid client ID or secret" |
| 6 | "Token has expired" |
| 7 | "Token is required" |
| 8 | "Error during internal request" |
| 9 | "ID is required" |
| 10 | "Database connection failed" |
| 11 | "No tags found" |
| 12 | "Token is invalid" |
| 13 | "Too many words" |
| 14 | "Ad limit reached" |
| 15 | "Required variable was not defined" |
Show Errors
Endpoints:
Available in versions: v1
Gets the last pushed tag (Current version).
Requires Auth:
Requires Key:
Returns:
major
Type: STRING Latest major tag (Requires client update)
minor
Type: STRING Latest minor tag (Server-only changes)
Available in versions: v1
Acquire an auth token for use with requests that require it.
Requires Auth:
Requires Key:
Parameters:
client_id
Type: STRING - Required
client_secret
Type: STRING - Required
Returns:
token
Type: STRING Session token valid for up to 1 hour after request
Errors:
2
A POST request is required
5
Invalid client ID or secret
Available in versions: v1
Get the url for downloading the full modpack or a patch. Triggers generation if necessary
Requires Auth:
Requires Key:
Parameters:
client_id
Type: STRING - Required
client_secret
Type: STRING - Required
token
Type: STRING - Required
patch_from
Type: STRING - Optional A tag to patch from
opt_mods
Type: ARRAY - Optional An array of optional mods to include
Returns:
id
Type: NUMBER The id to pass on to api/get_file/
filename
Type: STRING The filename that the file would have been given had it been downloaded through the GUI
size_raw
Type: NUMBER The file size in bytes
size
Type: STRING The file size in human-readable format, eg 12.5MB
mod_count_opt
Type: NUMBER
res_count
Type: NUMBER Resource pack count
Errors:
2
A POST request is required
5
Invalid client ID or secret
8
Error during internal request
Available in versions: v1
Download an archive by id
Requires Auth:
Requires Key:
Parameters:
client_id
Type: STRING - Required
client_secret
Type: STRING - Required
token
Type: STRING - Required
id
Type: NUMBER - Required The id of the file to download, provided by api/get_download_url/
Returns:
file
Type: FILE The requested file
error
Type: STRING On failure the error is returned as a plaintext string
Errors:
2
A POST request is required
5
Invalid client ID or secret
Available in versions: v1
Get a random server message (Same as the ones displayed in-game)
Requires Auth:
Requires Key:
Parameters:
ignore_time_limit
Type: STRING - Optional Should be 'true' to operate. Ignores the per-message time limit if set
Returns:
color
Type: STRING The messages color name
text
Type: STRING The message
Errors:
None
What could possibly go wrong?
Available in versions: v1
Test your token to see if it's still valid
Requires Auth:
Requires Key:
Parameters:
client_id
Type: STRING - Required
client_secret
Type: STRING - Required
token
Type: STRING - Required
Returns:
Just the default fields
Errors:
2
A POST request is required
5
Invalid client ID or secret
Available in versions: v1
Get a list of optional mods that can be provided to get_download_url
Requires Auth:
Requires Key:
Returns:
mods
Type: ARRAY An array of optional mods (or an empty array)
Available in versions: v1
Get a specific message from an error code, or get an array of all the error messages
Requires Auth:
Requires Key:
Parameters:
error_code
Type: INT - Optional An error code
Returns:
error_message
Type: STRING|ARRAY Either a single error message or an array of all error messages
Errors:
None
What could possibly go wrong?
Available in versions: v1
Gets one or more ads of all or specified types
Requires Auth:
Requires Key:
Parameters:
client_id
Type: STRING - Required
client_secret
Type: STRING - Required
token
Type: STRING - Required
type
Type: STRING - Optional Valid types are 'any', 'buy' and 'sell' - Default: 'any'
limit
Type: NUMBER - Optional Limit number of ads returned - Default: -1 (No limit)
Returns:
ads
Type: ARRAY A numeric array containing the fetched ads which in turn contain the following fields:
id
Type: NUMBER The incremental id of the ad
created_time
Type: NUMBER Unix timestamp of the creation time of the ad
bumped
Type: NUMBER Unix timestamp of the last bump of the ad
edited
Type: NUMBER Unix timestamp of the last edit
type
Type: STRING The type of the ad ('buy' or 'sell')
title
Type: STRING The title of the ad
body
Type: STRING The body of the ad
minecraft_name
Type: STRING The minecraft name of the ad owner
minecraft_uuid
Type: STRING The minecraft uuid of the ad owner (You could use this to fetch their head texture or similar from some service)
Errors:
2
A POST request is required
5
Invalid client ID or secret