1.0.3 • Published 4 years ago
mc-heads-api v1.0.3
mc-heads-api@1.0.1
npm install mc-heads-apiWhat is it?
This is a MC-Heads API and Ashcon API wrapper. It returns you data about a Minecraft player using its username or UUID.
Usage
Synchronous Function (Normal):
const mch = require('mc-heads-api');
mch
.getPlayer('blu_ey') // username or uuid
.then(player => {
console.log(player);
});Asynchronous Function:
const mch = require('mc-heads-api');
async function logPlayer() {
const player = await mch.getPlayer('blu_ey'); // username or uuid
console.log(player);
}
logPlayer();Result:
Player:
| Propertie | Type |
|---|---|
| status | 'success' |
| username | string |
| rawUuid | string |
| uuid | string |
| nameMc | string |
| createdAt | string |
| skin | Skin |
| usernameHistory | UsernameHistory[] |
Error:
| Propertie | Type |
|---|---|
| status | 'failed' |
| why | string |
Skin:
| Propertie | Type |
|---|---|
| comboAvatar | string |
| download | string |
| fullBody | string |
| custom | boolean |
| change | string |
| avatar | string |
| slim | boolean |
| head | string |
| body | string |
| skin | string |
UsernameHistory:
| Propertie | Type |
|---|---|
| username | string |
| changedAt | number |