Skip to main content

Downloads API

PaperMC provides a downloads API to facilitate automated downloads access. Full documentation can be found on the Downloads API Docs.

danger

We emphatically do not recommend using unstable builds or auto-updaters within production environments.

info

We require jq to be installed for the examples below. You can install it with sudo apt-get install jq on Debian/Ubuntu.

Getting the latest version

#!/usr/bin/env sh

PROJECT="paper"

LATEST_VERSION=$(curl -s https://api.papermc.io/v2/projects/${PROJECT} | \
jq -r '.versions[-1]')

echo "Latest version is $LATEST_VERSION"

This will get the latest available Minecraft version for the given project.

Getting the latest stable build number

This will get the latest stable build for the given project and Minecraft version, if it's available.

Downloading the latest stable build

This is the most common use case for the API. It will download the latest stable build for the given project and Minecraft version. You should always serve & use the stable builds. Experimental builds are prone to error and do not receive support.