Crafatar

Attribution

Attribution is not required, but it is encouraged.
If you want to show some support for this (free!) service, place a notice like this somewhere: Thank you to <a href="https://crafatar.com">Crafatar</a> for providing avatars.

URL Parameters

You can tweak images using query string parameters.
Example: <%= domain %>/avatars/853c80ef3c3749fdaa49938b674adae6?size=4&default=MHF_Steve&overlay

• size: The size for avatars in pixels. <%= config.avatars.min_size %> - <%= config.avatars.max_size %>
• scale: The scale factor for renders. <%= config.renders.min_scale %> - <%= config.renders.max_scale %>
• overlay: Apply the overlay to the avatar. Presence of this parameter implies true. This option was previously known as helm.
• default: The fallback to be used when the requested image cannot be served. You can use a custom URL, any uuid, or MHF_Steve/MHF_Alex.
  The option defaults to either MHF_Steve or MHF_Alex, depending on Minecraft's default for the requested UUID.

About UUIDs

UUIDs may be any valid Mojang UUID in the blank or dashed format.

Malformed UUIDs are rejected.

About Usernames

By disabling a legacy API in 2018, Mojang has made it practically impossible for Crafatar to support usernames. Please use UUIDs instead!

All usernames are rejected.

About Caching

Crafatar checks for skin updates every <%= config.caching.local / 60 %> minutes.
Images are cached in your browser for <%= config.caching.browser / 60 %> minutes until a new request to Crafatar is made.
In addition, CloudFlare caches up to 2 hours on a per-url basis.

When you changed your skin you can try clearing your browser cache to see the change faster.

CORS

Crafatar supports Cross-Origin Resource Sharing, so you can make AJAX request from other sites!

HTTP Headers

Responses come with some custom HTTP headers, useful for debugging.
Please note that these headers may be cached by CloudFlare.

• X-Storage-Type: Details about how the requested image was stored on the server
  • none: No external requests. Player has no skin (cached)
  • cached: No external requests. (skin cached)
  • checked: Requested skin details, skin cached. (1 external request)
    This happens either when the user removed their skin or when it didn't change.
  • downloaded: Requested skin details, skin downloaded. (2 external requests)
  • server error: This can happen, for example, when Mojang's servers are down.
    If possible, a cached image is served instead.
  • user error: You have done something wrong, such as requesting a malformed uuid.
    Check the response body for details.
• X-Request-ID: The internal ID assigned to this request.
  If you think something is wrong with your request, please contact us and provide this ID.