Player Cosmetics

Fetch a player's selected cosmetics and owned cosmetic item ids by Minecraft Bedrock username.

GET /player/item/{username}

Example:

curl "https://app.zeqa.net/api/player/item/zGqat"

Path Parameters

Parameter	Type	Description
username	string	Minecraft Bedrock username to look up. Usernames with unsupported characters return an error.

Response Shape

The result field is an array. For an existing player, the array contains the matching item record. For a valid username with no matching record, the array can be empty.

{
  "err": null,
  "result": [
    {
      "xuid": "2535422712303724",
      "name": "zGqat",
      "potcolor": "255,0,0",
      "projectile": "5",
      "tag": "",
      "artifact": "12",
      "cape": "379",
      "killphrase": "14",
      "ownedprojectile": "0,5",
      "ownedtag": "",
      "ownedartifact": "0,45,189,189,185,206,207,208,C65,C67,12,214,215",
      "ownedcape": "0,9,38,284,352,355,260,285,285,353,354,201,19,361,362,378,379",
      "ownedkillphrase": "0,48,48,47,60,14",
      "premium_bp": 0,
      "free_bp_progress": 18000,
      "premium_bp_progress": 0,
      "login_streak": 49,
      "mount": "0",
      "ownedmount": "0",
      "elitetag": ""
    }
  ]
}

Result Item Fields

Field	Type	Description
xuid	string	Player Xbox user id.
name	string	Player username returned by Zeqa.
potcolor	string	Selected potion color as an RGB string, such as 255,0,0.
projectile	string	Selected projectile cosmetic id.
tag	string	Selected tag cosmetic id or an empty string.
artifact	string	Selected artifact cosmetic id.
cape	string	Selected cape cosmetic id.
killphrase	string	Selected kill phrase cosmetic id.
ownedprojectile	string	Comma-separated projectile cosmetic ids owned by the player.
ownedtag	string	Comma-separated tag cosmetic ids owned by the player, or an empty string.
ownedartifact	string	Comma-separated artifact cosmetic ids owned by the player.
ownedcape	string	Comma-separated cape cosmetic ids owned by the player.
ownedkillphrase	string	Comma-separated kill phrase cosmetic ids owned by the player.
premium_bp	number	Premium battle-pass status as returned by Zeqa.
free_bp_progress	number	Free battle-pass progress.
premium_bp_progress	number	Premium battle-pass progress.
login_streak	number	Player login streak.
mount	string	Selected mount cosmetic id.
ownedmount	string	Comma-separated mount cosmetic ids owned by the player.
elitetag	string	Selected elite tag cosmetic id or an empty string.

JavaScript Example

async function getPlayerCosmetics(username) {
  const response = await fetch(
    `https://app.zeqa.net/api/player/item/${encodeURIComponent(username)}`,
  );
  const data = await response.json();

  if (data.err) {
    throw new Error(data.err);
  }

  return data.result;
}

Empty Result

{
  "err": null,
  "result": []
}

Error Response

{
  "err": "Invalid character in a name"
}