API Documentation

Overview

Mineatar was built to be an alternative to existing service which improves the speed and efficiency of rendering Minecraft player skins as 3-dimensional images. Whether or not you are migrating from an alternative service, we make it easy to get up and running quickly by providing a simple API to use. Everything you need to know to get started is documented below.

Caching

To prevent any abuse of our API, we implement a cache duration for all rendered images to reduce the amount of work our server has to do. When a skin is retrieved from Mojang, it is cached for 12 hours, meaning a fresh skin will not be retrieved until 12 hours from the previous. The rendered image is also cached for 12 hours. All requests will contain a X-Cache-Hit response header which contains a boolean value which determines whether you hit the cache for the resulting image. If the value was true, then the X-Cache-Time-Remaining header will contain the amount of seconds until that cache expires.

Query Parameters

There is a few ways to modify the resulting image from any API endpoint. Most endpoints support a scale query parameter which changes the size of the image, and a download parameter which tells your browser to open a save dialog. You can refer to the query parameters for each specific endpoint to learn about what you can modify.

scale (Number) — Increases or decreases the size of the image
overlay (Boolean) — Toggles the overlay (helmet layer) of the skin
download (Boolean) — Forces the browser to open a save dialog
format (String) — Changes the format of the image returned (values: png, jpg, jpeg, gif)