# Xbox gamerpic API

> Xbox lookups at avatarsapi.com/xboxgamertag/<handle> are currently failing. Handle format and status.

Put a Xbox Handle in the URL and the response is the gamerpic as image bytes, ready for an `<img src>`. avatarapi fetches it from Xbox, checks it is a real image, and caches it at the edge.

```html
<img src="https://avatarsapi.com/xboxgamertag/Major%20Nelson" alt="">
```

## What goes in the URL

`https://avatarsapi.com/xboxgamertag/<handle>`

An Xbox gamertag.

**Currently failing.** Xbox lookups are failing right now while we fix this Source. Ship a fallback.

Percent-encode the Handle if it contains a `/`, a space, or other reserved characters.

## Options

- `?size=16..1000` sets the square size in pixels (default 400): `https://avatarsapi.com/xboxgamertag/Major%20Nelson?size=64`
- `?json` returns the resolved image URL instead of the bytes:

```json
{ "version": 1, "data": { "url": "https://…", "source": "xboxgamertag", "kind": "username" } }
```

Starter Projects can also set `?ttl=1h..28d` for the cache lifetime (default 7 days).

## When there is no picture

If the account does not exist or has no gamerpic, the response is a 404 with a JSON body whose `code` is `ENOTFOUND`. That makes `onerror` a reliable fallback:

```html
<img
  src="https://avatarsapi.com/xboxgamertag/Major%20Nelson"
  onerror="this.onerror=null; this.src='/default-avatar.svg'"
  alt="">
```

`EUPSTREAM` (502) means Xbox itself failed or changed; it is usually transient. All codes are in the [error table](https://avatarsapi.com/docs#errors).

## Related

- [YouTube channel avatar API](/platforms/youtube)
- [Zhihu profile picture API](/platforms/zhihu)
- [App Store app icon API](/platforms/apple-store)
- [Apple Music artist, album, or song artwork API](/platforms/apple-music)
- [All 67 platforms](/platforms/)