Skip to navigation

Minecraft

Look up players, fetch skin textures, and render character images.
View as Markdown

Identifying a player

Every Minecraft route takes a {player} that accepts any of:

  • a Java or Bedrock username (Notch)
  • a Java UUID
  • a Floodgate UUID, for Bedrock players
  • an XUID, for Bedrock players

Bedrock accounts resolve through Geyser, so a Java name and its Bedrock equivalent reach the same player.

Player info

GET /v1/minecraft/info/{player}
const player = await aegis.minecraft.info('Notch')
player.id
player.name
player.platform // 'java' | 'bedrock'
player.slim // whether the skin uses the slim ("Alex") model
player.updatedAt

Skin textures

GET /v1/minecraft/textures/{player}

Returns URLs, not pixels:

const textures = await aegis.minecraft.textures('Notch')
textures.skin // skin texture URL, or null
textures.cape // cape texture URL, or null
textures.slim
textures.hash
textures.updatedAt

A player with no stored skin answers 404.

Renders

GET /v1/minecraft/render/{player}

Rendering takes long enough that it is queued. This endpoint is the one place in the API that answers 202 rather than 200:

const render = await aegis.minecraft.render('Notch', {
render: 'wave',
scale: 2,
})
const { status, result } = await aegis.jobs.wait(render.jobId, { timeout: 60 })
ParameterValuesDefault
renderhead, body, front, wave, sit, handstand, cutesit, standing, showing_behindwave
scale1–41
skinUrlAny skin texture URL—
capeUrlAny cape texture URL—

Passing skinUrl renders that texture directly and skips the player lookup entirely, which is how you render a skin for a player the API cannot resolve:

await aegis.minecraft.render('custom', {
skinUrl: 'https://textures.minecraft.net/texture/abc123',
render: 'standing',
})

Errors

Minecraft routes are the only ones that can return 502, because they talk to upstream services:

StatusCause
400The identifier is malformed
404No such player, or no stored skin for textures
502The upstream Minecraft service failed

Cost

Info and textures are cheap. Renders are puppeteer — the most expensive class, and not included on the free plan. See rate limits.