Note: This repository only hosts versions 1 and 2 of the API, which are no longer operational. Version 3 can be found at https://github.com/wurstmineberg/wurstmineberg.de/blob/master/wurstmineberg_web/api.py.
This is Wurstmineberg's Minecraft API, an API server using bottle.py that exposes Minecraft server data via JSON. It is not to be confused with Minecraft's official API which is currently in development.
It can be found live on http://api.wurstmineberg.de/.
This is version 2.5.0 of the API (semver). A list of available endpoints along with brief documentation can be found on its index page.
Requirements
- Python 3.4
- Pillow 3.0 (required for image-producing endpoints only)
- bottle 0.12
- mcstatus 2.1 (required for world status endpoints only)
- minecraft-backuproll 0.1 (required for world backup endpoints only)
- more-itertools 2.2
- nbt 1.4
- people (required for people.json features only)
- playerhead 3.0 (required for skin rendering endpoints only)
- python-anvil (required for chunk endpoints only)
- requests 2.7
- systemd-minecraft
Configuration
If you are using nginx, you can for the most part follow this guide. Just use api.py instead of writing your own app.py as in the guide, and make sure to install uwsgi-plugin-python3 and python3-bottle instead of their Python 2 counterparts.
If you're using the Apache httpd or another web server, you're on your own for setting up the API.
Some endpoints use logs generated by wurstminebot. If you don't run a wurstminebot on your server, you will have to provide logs in a compatible format in order to use these endpoints.
You can provide a configuration file in /opt/wurstmineberg/config/api.json to customize some behavior. Here are the default values:
{
"cache": "/opt/wurstmineberg/api-cache",
"host": "wurstmineberg.de",
"jlogPath": "/opt/wurstmineberg/jlog",
"logPath": "/opt/wurstmineberg/log",
"moneysFile": "/opt/wurstmineberg/moneys/moneys.json",
"webAssets": "/opt/git/github.com/wurstmineberg/assets.wurstmineberg.de/master",
"worldHost": "wurstmineberg.de"
}