# Mastodon profile picture API

> Get any Mastodon profile picture from one image URL: avatarsapi.com/mastodon/<handle>. No Mastodon API key, no scraping code.

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

```html
<img src="https://avatarsapi.com/mastodon/Gargron%40mastodon.social" alt="">
```

## What goes in the URL

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

The full address `user@instance`, with or without a leading `@`.

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/mastodon/Gargron%40mastodon.social?size=64`
- `?json` returns the resolved image URL instead of the bytes:

```json
{ "version": 1, "data": { "url": "https://…", "source": "mastodon", "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 profile picture, 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/mastodon/Gargron%40mastodon.social"
  onerror="this.onerror=null; this.src='/default-avatar.svg'"
  alt="">
```

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

## Related

- [Medium profile picture API](/platforms/medium)
- [NetEase Cloud Music profile picture API](/platforms/netease-music)
- [npm profile picture API](/platforms/npm)
- [OpenStreetMap profile picture API](/platforms/openstreetmap)
- [All 67 platforms](/platforms/)