fetch-avatar

A package to fetch avatars from various websites

Usage no npm install needed!

<script type="module">
  import fetchAvatar from 'https://cdn.skypack.dev/fetch-avatar';
</script>

README

Fetch-Avatar

Fetch avatars from various websites using usernames, IDs or emails.

NPM NPM NPM

Install

npm install fetch-avatar

Usage:

For most providers you can simply pass a username or email.
If the user has an avatar you'll receive a URL, otherwise the response will be null

import { avatar } from 'fetch-avatar';

avatar.github('DrKain').then(console.log);
// https://avatars.githubusercontent.com/u/5300315

API Keys:

Some providers will require an API to function. I've tried to avoid this best I can but sometimes it's unavoidable. When a provider requires an API key. Please visit the GitHub wiki to see how to use these. Each provider that requires an API key or token has their own page showing how to get one.

Default Avatars

This package will attempt to detect and remove default avatars from providers. If a default avatar is detected the response will be null.

Supported:

Planned: