# Ko-fi profile picture API

> Ko-fi lookups at avatarsapi.com/ko-fi/<handle> are currently failing. Handle format and status.

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

```html
<img src="https://avatarsapi.com/ko-fi/kofi" alt="">
```

## What goes in the URL

`https://avatarsapi.com/ko-fi/<handle>`

The page name from `ko-fi.com/<name>`.

**Currently failing.** Ko-fi 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/ko-fi/kofi?size=64`
- `?json` returns the resolved image URL instead of the bytes:

```json
{ "version": 1, "data": { "url": "https://…", "source": "ko-fi", "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/ko-fi/kofi"
  onerror="this.onerror=null; this.src='/default-avatar.svg'"
  alt="">
```

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

## Related

- [LinkedIn profile picture or company logo API](/platforms/linkedin)
- [Mastodon profile picture API](/platforms/mastodon)
- [Medium profile picture API](/platforms/medium)
- [NetEase Cloud Music profile picture API](/platforms/netease-music)
- [All 67 platforms](/platforms/)