Skip to content

A simple and fast Minecraft avatar API built with JS, ExpressJs and MongoDB.

License

Notifications You must be signed in to change notification settings

iAverages/SkinsAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SkinsAPI

A simple and fast Minecraft avatar API built with JS, ExpressJs and MongoDB.

A public endpoint for this can be found at https://skins.danielraybone.com/.

Features

  • Player name support
  • UUID Support
  • Request custom size
  • Get skin
  • Get head
  • Get 2d full front body of skin
  • Get cape
  • Get profile of player (See example below)
  • Support for second layer of skin
  • Get 3d Model of skin
  • Get 3d Model of head
  • Proxy requests when being rate limited

Endpoints

Global info

All API requests are GET requests.
:name - Can be a players username (iAverage) or UUID (1b8f18cf-7fb6-4a7a-8c25-c1ef296459f2) with or without dashes (-)
If a invalid name or UUID is given, steve will be returned instead.
The second layer of the skin is enabled by default and can be disabled by using the query string params ?overlay=false When a skin needs to be rechecked for updated, the api will return the skin in the cache. It will also begin to check for a updated skin.

v1

/v1/profile/:name - Returns the players profile. Example
/v1/skin/:name - Returns the skin of the player.
/v1/head/:name - Returns the head of the player.
/v1/body/:name - Returns the 2d version of the players full body, as if you was facing them in game. Example
/v1/cape/:name - Returns the users first cape (Doesn't include Optifine capes)
/v1/render/body/:name - Returns a 3d render of the players full body. Example
/v1/render/head/:name - Returns a 3d render of the players head. Example

v1 - Query string params

?overlay=true|false - Option to disable the players second layer. Currently only works on 2d renders (head, body).
?base64=true - Option to return a base64 version of the image. Applies to routes returning an image.
?width=300 - Custom return width in pixels. Max 1000. Currently doesn't work with 3d renders.
?height=300 - Custom return height in pixels. Max 1000. Currently doesn't work with 3d renders.

v1 - Headers

X-Error - If any errors or problems occur while processing the request, this header will be set. All routes will return some info, steve skin/profile or a previously cached skin/profile.

About

A simple and fast Minecraft avatar API built with JS, ExpressJs and MongoDB.

Resources

License

Stars

Watchers

Forks