Crafatar

Documentation

Avatars

Replace userid with a Mojang UUID or username to get the related head. All images are PNGs.

<%= domain %>/avatars/ userid

Avatar Parameters

parameter	type	default	description
size	integer	<%= config.avatars.default_size %>	The size of the image in pixels, <%= config.avatars.min_size %> - <%= config.avatars.max_size%>.
default	string	The standard value is calculated based on the UUID (even = MHF_Alex, odd = MHF_Steve). Usernames always default to MHF_Steve.	The image to be served when the userid has no skin. Valid options are any userid, including MHF_Steve and MHF_Alex, or a custom URL.
helm	null		Apply the "second" layer (hat) to the avatar.

Avatar Examples

<%= domain %>/avatars/jeb_

Jeb's avatar

<%= domain %>/avatars/jeb_?helm

Jeb's avatar with helm

<%= domain %>/avatars/jeb_?size=128

Jeb's avatar, 128 × 128

<%= domain %>/avatars/853c80ef3c3749fdaa49938b674adae6

Jeb's avatar by UUID

<%= domain %>/avatars/jeb_?default=MHF_Alex

Jeb's avatar, or fall back to MHF_Alex (this example assumes jeb_ does not exist)

<%= domain %>/avatars/jeb_?default=https%3A%2F%2Fi.imgur.com%2FocJVWAc.png

Jeb's avatar, or fall back to a custom image (this example assumes jeb_ does not exist)

Hover over the example URLs above for a preview!

Crafatar also provides support for 3D renders of Minecraft skins.
Please note that this feature is currently beta!
Replace userid with a Mojang UUID or username to get a render of the skin. The head render type returns a render of the skin's head.<%= domain %>/renders/head/useridThe body render returns a render of the entire skin.<%= domain %>/renders/body/userid

Render Parameters

parameter	type	default	description
scale	integer	<%= config.renders.default_scale %>. The actual size differs between the type of render.	The scale factor of the image <%= config.renders.min_scale %> - <%= config.renders.max_scale %>.
helm	null		Apply the "second" layer (hat) to the avatar.
default	string	The standard value is calculated based on the UUID (even = MHF_Alex, odd = MHF_Steve). Usernames always default to MHF_Steve.	The image to be served when the userid has no skin. Valid options are any userid, including MHF_Steve and MHF_Alex, or a custom URL.

Render Examples

<%= domain %>/renders/body/jeb_?helm&scale=4

Jeb's body, with helmet, scale 4

<%= domain %>/renders/head/853c80ef3c3749fdaa49938b674adae6?scale=8

Jeb's head, by UUID, scale 8

Hover over the example URLs above for a preview!

Skins

You can also get the full skin file of a player.
Replace userid with a Mojang UUID or username to get the related skin.
The user's skin is returned, or the default image is served.
You can use the default parameter here as well.<%= domain %>/skins/userid

Skin Parameters

parameter	type	default	description
default	string	The standard value is calculated based on the UUID (even = MHF_Alex, odd = MHF_Steve). Usernames always default to MHF_Steve.	The image to be served when the userid has no skin. Valid options are any userid, including MHF_Steve and MHF_Alex, or a custom URL.

Skin Examples

<%= domain %>/skins/jeb_

Jeb's skin

<%= domain %>/skins/jeb_?default=MHF_Alex

Jeb's skin, or fall back to MHF_Alex (this example assumes jeb_ does not exist)

Hover over the example URLs above for a preview!

Capes

A cape endpoint is also available to get the active cape of a user.
Replace userid with a Mojang UUID or username to get the related cape.
The user's cape is returned, otherwise a 404 is returned.

<%= domain %>/capes/ userid