README
mojang-minecraft-api
🎮 Wrapper for the Mojang API
Installation
npm install mojang-minecraft-api
Functions
- getServiceStatus() ⇒
Object Gets the current service status of various Mojang services
- getUUID(username) ⇒
Object Gets the UUID of a player
- getNameHistory(uuid) ⇒
Object Gets the name history of a player
- getNameHistoryByName(username) ⇒
Object Gets the name history of a player
- getUUIDs(names) ⇒
Object Gets the UUIDs for multiple players
- getProfile(uuid) ⇒
Object Gets the profile of a player
- getProfileByName(username) ⇒
Object Gets the profile of a player
- getSkinData(uuid) ⇒
Object Gets the skin data of a player
- getSkinDataByName(username) ⇒
Object Gets the skin data of a player
- getSkinURL(uuid) ⇒
string Gets the skin URL of a player
- getSkinURLByName(username) ⇒
string Gets the skin URL of a player
- getPlayerHead(uuid) ⇒
string Gets the player head image of a player
- getPlayerHeadByName(username) ⇒
string Gets the player head image of a player
getServiceStatus() ⇒ Object
Gets the current service status of various Mojang services
Kind: global function
Returns: Object - - An Object that contains the status of various Mojang services
getUUID(username) ⇒ Object
Gets the UUID of a player
Kind: global function
Returns: Object - - This will return the UUID of the name that is provided
| Param | Type | Description |
|---|---|---|
| username | string |
The username of the player |
getNameHistory(uuid) ⇒ Object
Gets the name history of a player
Kind: global function
Returns: Object - - This will return all the usernames this user used in the past and the one they are using currently.
| Param | Type | Description |
|---|---|---|
| uuid | string |
The UUID from the player |
getNameHistoryByName(username) ⇒ Object
Gets the name history of a player
Kind: global function
Returns: Object - - This will return all the usernames this user used in the past and the one they are using currently.
| Param | Type | Description |
|---|---|---|
| username | string |
The username of the player |
getUUIDs(names) ⇒ Object
Gets the UUIDs for multiple players
Kind: global function
Returns: Object - - This will return the UUID's and names of the players that are provided
| Param | Type | Description |
|---|---|---|
| names | Array.<string> |
An array with player names |
getProfile(uuid) ⇒ Object
Gets the profile of a player
Kind: global function
Returns: Object - - This will return the player's username and other additional information (e.g. skins)
| Param | Type | Description |
|---|---|---|
| uuid | string |
The UUID from the player |
getProfileByName(username) ⇒ Object
Gets the profile of a player
Kind: global function
Returns: Object - - This will return the player's username and other additional information (e.g. skins)
| Param | Type | Description |
|---|---|---|
| username | string |
The username of the player |
getSkinData(uuid) ⇒ Object
Gets the skin data of a player
Kind: global function
Returns: Object - - This will return the player's skin information (e.g. skin url)
| Param | Type | Description |
|---|---|---|
| uuid | string |
The UUID from the player |
getSkinDataByName(username) ⇒ Object
Gets the skin data of a player
Kind: global function
Returns: Object - - This will return the player's skin information (e.g. skin URL)
| Param | Type | Description |
|---|---|---|
| username | string |
The username of the player |
getSkinURL(uuid) ⇒ string
Gets the skin URL of a player
Kind: global function
Returns: string - - This will return the URL of the player skin
| Param | Type | Description |
|---|---|---|
| uuid | string |
The UUID from the player |
getSkinURLByName(username) ⇒ string
Gets the skin URL of a player
Kind: global function
Returns: string - - This will return the URL of the player skin
| Param | Type | Description |
|---|---|---|
| username | string |
The username of the player |
getPlayerHead(uuid) ⇒ string
Gets the player head image of a player
Kind: global function
Returns: string - - This will return a base64 string of the player head image (8x8)
| Param | Type | Description |
|---|---|---|
| uuid | string |
The UUID from the player |
getPlayerHeadByName(username) ⇒ string
Gets the player head image of a player
Kind: global function
Returns: string - - This will return a base64 string of the player head image (8x8)
| Param | Type | Description |
|---|---|---|
| username | string |
The username of the player |