{"id":13459101,"url":"https://github.com/microlinkhq/unavatar","last_synced_at":"2026-05-02T23:05:32.149Z","repository":{"id":38027889,"uuid":"130118224","full_name":"microlinkhq/unavatar","owner":"microlinkhq","description":"Get unified user avatar from social networks, including Instagram, SoundCloud, Telegram, Twitter, YouTube \u0026 more.","archived":false,"fork":false,"pushed_at":"2026-04-25T10:31:49.000Z","size":1922,"stargazers_count":1425,"open_issues_count":2,"forks_count":83,"subscribers_count":7,"default_branch":"master","last_synced_at":"2026-04-29T02:40:56.522Z","etag":null,"topics":["avatar","avatar-placeholder","avatar-service","microservice"],"latest_commit_sha":null,"homepage":"https://unavatar.io","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microlinkhq.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-04-18T20:28:06.000Z","updated_at":"2026-04-28T11:20:53.000Z","dependencies_parsed_at":"2023-10-02T10:00:19.502Z","dependency_job_id":"8dfdd153-f9ef-4348-a2e7-23c8c2f5233a","html_url":"https://github.com/microlinkhq/unavatar","commit_stats":null,"previous_names":["kikobeats/unavatar"],"tags_count":376,"template":false,"template_full_name":null,"purl":"pkg:github/microlinkhq/unavatar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microlinkhq%2Funavatar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microlinkhq%2Funavatar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microlinkhq%2Funavatar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microlinkhq%2Funavatar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microlinkhq","download_url":"https://codeload.github.com/microlinkhq/unavatar/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microlinkhq%2Funavatar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32549555,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-02T19:18:06.202Z","status":"ssl_error","status_checked_at":"2026-05-02T19:16:21.335Z","response_time":132,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["avatar","avatar-placeholder","avatar-service","microservice"],"created_at":"2024-07-31T09:01:04.081Z","updated_at":"2026-05-02T23:05:32.139Z","avatar_url":"https://github.com/microlinkhq.png","language":"HTML","funding_links":[],"categories":["JavaScript","HTML"],"sub_categories":[],"readme":"![logo](https://unavatar.io/api/og ':id=banner')\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Quick start](#quick-start)\n- [Attribution](#attribution)\n  - [How to add attribution](#how-to-add-attribution)\n  - [Remove attribution](#remove-attribution)\n- [Authentication](#authentication)\n- [Pricing](#pricing)\n- [Cache](#cache)\n- [Query parameters](#query-parameters)\n  - [TTL](#ttl)\n  - [Fallback](#fallback)\n  - [JSON](#json)\n- [Providers](#providers)\n  - [Apple Music](#apple-music)\n  - [Apple Store](#apple-store)\n  - [Behance](#behance)\n  - [Bluesky](#bluesky)\n  - [Buy Me a Coffee](#buy-me-a-coffee)\n  - [DeviantArt](#deviantart)\n  - [Discord](#discord)\n  - [Domain](#domain)\n  - [Dribbble](#dribbble)\n  - [DuckDuckGo](#duckduckgo)\n  - [Email](#email)\n  - [Facebook](#facebook)\n  - [Flickr](#flickr)\n  - [GitHub](#github)\n  - [GitLab](#gitlab)\n  - [Google](#google)\n  - [Google Play](#google-play)\n  - [Gravatar](#gravatar)\n  - [Instagram](#instagram)\n  - [Ko-fi](#ko-fi)\n  - [LinkedIn](#linkedin)\n  - [Mastodon](#mastodon)\n  - [Medium](#medium)\n  - [Microlink](#microlink)\n  - [OnlyFans](#onlyfans)\n  - [OpenStreetMap](#openstreetmap)\n  - [Patreon](#patreon)\n  - [Pinterest](#pinterest)\n  - [Printables](#printables)\n  - [PSN Profiles](#psn-profiles)\n  - [Reddit](#reddit)\n  - [Snapchat](#snapchat)\n  - [SoundCloud](#soundcloud)\n  - [Spotify](#spotify)\n  - [Stack Overflow](#stack-overflow)\n  - [Steam](#steam)\n  - [Substack](#substack)\n  - [Telegram](#telegram)\n  - [Threads](#threads)\n  - [TikTok](#tiktok)\n  - [Tumblr](#tumblr)\n  - [Twitch](#twitch)\n  - [Vimeo](#vimeo)\n  - [WhatsApp](#whatsapp)\n  - [X/Twitter](#xtwitter)\n  - [Xbox Gamertag](#xbox-gamertag)\n  - [YouTube](#youtube)\n- [Response Format](#response-format)\n- [Response Headers](#response-headers)\n- [Response Errors](#response-errors)\n- [Contact](#contact)\n\n---\n\nLast updated on April 29, 2026\n\n## Introduction\n\nWelcome to **unavatar.io**, the ultimate avatar service that offers everything you need to easily retrieve user avatars:\n\n- **Versatile**: A wide range of platforms and services including [TikTok](https://unavatar.io/docs#tiktok), [Instagram](https://unavatar.io/docs#instagram), [YouTube](https://unavatar.io/docs#youtube), [X/Twitter](https://unavatar.io/docs#xtwitter), [Gravatar](https://unavatar.io/docs#gravatar), etc., meaning you can rule all of them just querying against unavatar.\n\n- **Speed**: Designed to be fast and efficient with a 91% cache hit rate, serving 12.5 TB of data across 382M requests.\n\n- **Optimize**: All the images are not only compressed on-the-fly to reduce their size and save bandwidth, but also optimized to maintain a high-quality ratio. They are ready for immediate use, enhancing the overall optimization of your website or application.\n\n- **Integration**: The service seamlessly incorporates into your current applications or websites with ease. We offer straightforward documentation and comprehensive support to ensure a quick and effortless onboarding experience.\n\nIt's proudly powered by [microlink.io](https://microlink.io/), the headless browser API that handles all the heavy lifting behind the scenes to ensure your avatars are always ready.\n\n## Quick start\n\nThe service is exposed in **unavatar.io** via endpoints.\n\nAn endpoint determines how the avatar is looked up and what parameters are required.\n\nFor example, you can get an avatar for:\n\n- an **email**: [unavatar.io/email/hello@microlink.io](https://unavatar.io/email/hello@microlink.io)\n- an **username**: [unavatar.io/github/kikobeats](https://unavatar.io/github/kikobeats)\n- a **domain**: [unavatar.io/domain/reddit.com](https://unavatar.io/domain/reddit.com)\n\nRead [providers](https://unavatar.io/docs#providers) to know more. Each provider can accept different parameters.\n\n## Attribution\n\nFree plans require attribution. Upgrade to any paid plan to remove this requirement.\n\nAttribution ensures proper domain verification and helps us keep unavatar.io free for the community.\n\nYour attribution link:\n\n- Must be on your production site (not staging or localhost).\n- Must be publicly accessible and viewable in browsers.\n- Must not use rel=\"nofollow\", redirects, or obfuscation.\n\n### How to add attribution\n\nAdd this link on any page or surface displaying unavatar.io avatars:\n\n```html\n[Avatars provided by Unavatar](https://unavatar.io)\n```\n\n**Example**\n\n```html\n\n  ![Kiko](https://unavatar.io/github/kikobeats)\n\n  ![Joseba](https://unavatar.io/x/josebaseba)\n\n\u003cp class=\"attribution\"\u003e\n\n  [Avatars provided by Unavatar](https://unavatar.io)\n\n\u003c/p\u003e\n```\n\n**Valid placements**\n\nSite footer, about page, credits page, or any page that renders avatars.\n\n**Mobile apps and non-web products**\n\nIf avatars are displayed in a mobile app, desktop app, browser extension, email, or any non-web surface, add the attribution link on your app's marketing site, app store listing description, or credits screen.\n\n**Requirements for attribution to be valid**\n\nWe reserve the right to revoke free-tier access for any website or product that does not comply with the attribution requirements described in this document:\n\n- Double-check the href. It must point to [https://unavatar.io](https://unavatar.io/) directly — no redirects, no URL shorteners, no tracking wrappers.\n- Make sure it's crawlable. The link must be present in the rendered HTML and not blocked by robots.txt, authentication, or region gating.\n- Avoid nofollow or noindex. We need a standard, followable link.\n- target=\"\\_blank\" is allowed.\n\n### Remove attribution\n\nAttribution is only required on the free plan. [Upgrade to the PRO plan](https://unavatar.io/checkout) to remove the requirement.\n\n## Authentication\n\nAnonymous requests work without authentication. They are limited to 25 requests/day per IP address.\n\nFor [PRO](https://unavatar.io/checkout) users, the requests must include the API key as the `x-api-key` request header:\n\n```bash\ncurl \"https://unavatar.io/github/kikobeats\" -H \"x-api-key: YOUR_API_KEY\"\n```\n\n```javascript\nawait fetch('https://unavatar.io/github/kikobeats', {\n\n  headers: {\n\n    'x-api-key': 'YOUR_API_KEY'\n\n  }\n\n})\n```\n\n```python\nimport requests\n\nresponse = requests.get(\n\n  'https://unavatar.io/github/kikobeats',\n\n  headers={'x-api-key': 'YOUR_API_KEY'}\n\n)\n```\n\n```golang\npackage main\n\nimport \"net/http\"\n\nfunc main() {\n\n  req, _ := http.NewRequest(\"GET\", \"https://unavatar.io/github/kikobeats\", nil)\n\n  req.Header.Set(\"x-api-key\", \"YOUR_API_KEY\")\n\n  resp, _ := http.DefaultClient.Do(req)\n\n  defer resp.Body.Close()\n\n}\n```\n\n```ruby\nrequire 'net/http'\n\nrequire 'uri'\n\nuri = URI('https://unavatar.io/github/kikobeats')\n\nrequest = Net::HTTP::Get.new(uri)\n\nrequest['x-api-key'] = 'YOUR_API_KEY'\n\nresponse = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|\n\n  http.request(request)\n\nend\n```\n\n```php\n$ch = curl_init('https://unavatar.io/github/kikobeats');\n\ncurl_setopt($ch, CURLOPT_HTTPHEADER, [\n\n  'x-api-key: YOUR_API_KEY',\n\n]);\n\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\n\n$response = curl_exec($ch);\n\ncurl_close($ch);\n```\n\nIf the API key is invalid, the service returns `401` with code `EAPIKEY`.\n\nRate limit status can be verified using these response headers:\n\n| Header                   | Description                                                    |\n| ------------------------ | -------------------------------------------------------------- |\n| `x-rate-limit-limit`     | Maximum anonymous requests allowed in the current daily window |\n| `x-rate-limit-remaining` | Requests remaining in the current window                       |\n| `x-rate-limit-reset`     | UTC epoch seconds when the current window resets               |\n\n```bash\n$ curl -I https://unavatar.io/github/kikobeats\n\nx-rate-limit-limit: 25\n\nx-rate-limit-remaining: 24\n\nx-rate-limit-reset: 1744243200\n```\n\n## Pricing\n\nUnavatar pricing is simple: you can start on the anonymous free tier, then authenticate with `x-api-key` to get additional included usage and metered billing for higher volume.\n\n| Scenario                                     | Included free usage    | Billing                          |\n| -------------------------------------------- | ---------------------- | -------------------------------- |\n| Anonymous (no API key)                       | 25 requests/day per IP | Free                             |\n| Authenticated origin requests (`x-api-key`)  | 50 origin requests/day | Metered monthly after free quota |\n| Proxy requests (`datacenter`, `residential`) | None                   | Always metered                   |\n\nFor higher usage, the **[PRO](https://unavatar.io/checkout)** plan is usage-based billing that includes the 50 free daily origin requests, metered overage, and custom TTL.\n\nEvery request has a cost in tokens (**\\$0.005 per token**) based on the proxy tier needed to resolve the avatar:\n\n| Proxy tier  | Tokens | Cost    |\n| ----------- | :----: | :-----: |\n| Origin      | 1      | \\$0.005 |\n| Datacenter  | +2     | \\$0.015 |\n| Residential | +4     | \\$0.025 |\n\nThe proxy tier used is returned in the `x-proxy-tier` response header, and the total cost in the `x-unavatar-cost` header.\n\n```bash\n$ curl -I -H \"x-api-key: YOUR_API_KEY\" https://unavatar.io/instagram/kikobeats\n\nx-pricing-tier: pro\n\nx-proxy-tier: origin\n\nx-unavatar-cost: 1\n```\n\nTo upgrade, visit [unavatar.io/checkout](https://unavatar.io/checkout). After completing the payment, you'll receive an API key.\n\n## Cache\n\nUnavatar caches avatar lookups to make repeated requests fast and stable:\n\n- The first request for a resource fetches the avatar from upstream and stores it in cache\n- Following requests are served from cache until the [TTL](https://unavatar.io/docs#ttl) expires.\n\nFor example, if you set `ttl=1h`, the cache behavior looks like this:\n\n| Time  | Request                 | Cache status                        | Plan impact                |\n| ----- | ----------------------- | ----------------------------------- | -------------------------- |\n| 10:00 | `GET /github/kikobeats` | MISS (fetched from upstream)        | Counts as 1 origin request |\n| 10:05 | `GET /github/kikobeats` | HIT (served from cache)             | No usage consumed, no cost |\n| 10:40 | `GET /github/kikobeats` | HIT (served from cache)             | No usage consumed, no cost |\n| 11:02 | `GET /github/kikobeats` | MISS (TTL expired, cache refreshed) | Counts as 1 origin request |\n| 11:10 | `GET /github/kikobeats` | HIT (served from cache)             | No usage consumed, no cost |\n\nTo check the cache status in real requests, inspect these response headers:\n\n| Header           | What to look for                                                                        |\n| ---------------- | --------------------------------------------------------------------------------------- |\n| `x-cache-status` | `HIT` means served from cache. `MISS` means fetched/refreshed from upstream.            |\n| `cache-control`  | Shows cache policy and effective TTL (for example `public, max-age=3600` for `ttl=1h`). |\n\n```bash\n$ curl -I -H \"x-api-key: YOUR_API_KEY\" \"https://unavatar.io/github/kikobeats?ttl=1h\"\n\ncache-control: public, max-age=3600\n\nx-cache-status: HIT\n```\n\nThe same rule applies to anonymous requests: cache hits are free and do not consume the `25 requests/day` limit.\n\nAfter TTL expiration, the next request refreshes the cache and is billed/rate-limited according to the request tier (`anonymous`, `origin`, `datacenter`, or `residential`).\n\n## Query parameters\n\n### TTL\n\nType: `number` or `string`\\\nDefault: `'24h'`\\\nRange: from `'1h'` to `'28d'`\n\nIt determines the maximum quantity of time an avatar is considered fresh.\n\ne.g., [unavatar.io/github/kikobeats?ttl=1h](https://unavatar.io/github/kikobeats?ttl=1h)\n\nWhen you look up for a user avatar for the very first time, the service will determine it and cache it respecting TTL value.\n\nThe same resource will continue to be used until reach TTL expiration. After that, the resource will be computed, and cache as fresh, starting the cycle.\n\n### Fallback\n\nType: `string` or `boolean`\n\nWhen it can't be possible to get a user avatar, a fallback image is returned instead, and it can be personalized to fit better with your website or application style.\n\nYou can get one from **boringavatars.com**:\n\ne.g., [unavatar.io/github/37t?fallback=https://source.boringavatars.com/marble/120/1337_user?colors=264653r,2a9d8f,e9c46a,f4a261,e76f51](https://unavatar.io/github/37t?fallback=https://source.boringavatars.com/marble/120/1337_user?colors=264653r,2a9d8f,e9c46a,f4a261,e76f51)\n\nor **avatar.vercel.sh**:\n\ne.g., [unavatar.io/github/37t?fallback=https://avatar.vercel.sh/37t?size=400](https://unavatar.io/github/37t?fallback=https://avatar.vercel.sh/37t?size=400)\n\nor a static image:\n\ne.g., [unavatar.io/github/37t?fallback=https://avatars.githubusercontent.com/u/66378906?v=4](https://unavatar.io/github/37t?fallback=https://avatars.githubusercontent.com/u/66378906?v=4)\n\nor even a base64 encoded image. This allows you to return a transparent, base64 encoded 1x1 pixel GIF, which can be useful when you want to use your own background colour or image as a fallback.\n\ne.g., [unavatar.io/github/37t?fallback=data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==](https://unavatar.io/github/37t?fallback=data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==)\n\nYou can pass `fallback=false` to explicitly disable this behavior. In this case, a *404 Not Found* HTTP status code will returned when is not possible to get the user avatar.\n\n### JSON\n\nThe service returns media content by default.\n\nThis makes the service easier to consume directly from HTML markup.\n\nIn case you want to get a JSON payload as response, just pass `json=true`:\n\ne.g., [unavatar.io/github/kikobeats?json](https://unavatar.io/github/kikobeats?json)\n\n## Providers\n\n### Apple Music\n\nGet artwork for any Apple Music artist, album, or song. Search by name or look up directly by numeric Apple Music ID.\n\nThe endpoint supports explicit type as part of the input.\n\nIf explicit type is not provided, it searches `artist` and `song` (in that order).\n\nAvailable inputs:\n\n- artist\n  - by artist name: [unavatar.io/apple-music/artist:daft%20punk](https://unavatar.io/apple-music/artist:daft%20punk)\n  - by numeric artist ID: [unavatar.io/apple-music/artist:5468295](https://unavatar.io/apple-music/artist:5468295)\n- album\n  - by album name: [unavatar.io/apple-music/album:discovery](https://unavatar.io/apple-music/album:discovery)\n  - by album ID: [unavatar.io/apple-music/album:78691923](https://unavatar.io/apple-music/album:78691923)\n- song\n  - by song name: [unavatar.io/apple-music/song:harder%20better%20faster%20stronger](https://unavatar.io/apple-music/song:harder%20better%20faster%20stronger)\n  - by song ID: [unavatar.io/apple-music/song:697195787](https://unavatar.io/apple-music/song:697195787)\n\n### Apple Store\n\nGet the icon for any iOS or macOS app on the App Store by numeric Apple ID.\n\nThe endpoint supports explicit type as part of the input.\n\nIf explicit type is not provided, it defaults to `id`.\n\nAvailable inputs:\n\n- `id` (default): [unavatar.io/apple-store/id:529479190](https://unavatar.io/apple-store/id:529479190) or [unavatar.io/apple-store/id:6474323148@es](https://unavatar.io/apple-store/id:6474323148@es)\n- `name`: [unavatar.io/apple-store/name:pokemon%20go](https://unavatar.io/apple-store/name:pokemon%20go)\n\n### Behance\n\nGet any Behance user's profile picture by their username.\n\ne.g., [unavatar.io/behance/vitormatosinhos](https://unavatar.io/behance/vitormatosinhos)\n\n### Bluesky\n\nGet any Bluesky user's profile picture by their handle. Domain-style handles are supported.\n\nAvailable inputs:\n\n- User handle, e.g., [unavatar.io/bluesky/pfrazee.com](https://unavatar.io/bluesky/pfrazee.com)\n- Domain handle, e.g., [unavatar.io/bluesky/bsky.app](https://unavatar.io/bluesky/bsky.app)\n\n### Buy Me a Coffee\n\nGet any Buy Me a Coffee creator's profile picture by their username.\n\ne.g., [unavatar.io/buymeacoffee/mikebarnesdrums](https://unavatar.io/buymeacoffee/mikebarnesdrums)\n\n### DeviantArt\n\nGet any DeviantArt user's profile picture by their username.\n\ne.g., [unavatar.io/deviantart/spyed](https://unavatar.io/deviantart/spyed)\n\n### Discord\n\nGet a Discord server's icon by server name or server ID.\n\nAvailable inputs:\n\n- Server name, e.g., [unavatar.io/discord/lilnasx](https://unavatar.io/discord/lilnasx)\n- Server ID, e.g., [unavatar.io/discord/uW6Hyf3E9r](https://unavatar.io/discord/uW6Hyf3E9r)\n\n### Domain\n\nRetrieve logos and favicons from any hostname with a single URL. Domain-shaped paths try DuckDuckGo, Google, Microlink in order until one returns an image, same as the explicit `/domain/:key` route.\n\ne.g., [unavatar.io/domain/microlink.io](https://unavatar.io/domain/microlink.io)\n\n### Dribbble\n\nGet any Dribbble designer's profile picture by their username.\n\ne.g., [unavatar.io/dribbble/omidnikrah](https://unavatar.io/dribbble/omidnikrah)\n\n### DuckDuckGo\n\nGet the favicon or logo for any domain via DuckDuckGo's icon service. Useful as a fallback when a domain doesn't expose its favicon directly.\n\ne.g., [unavatar.io/duckduckgo/microsoft.com](https://unavatar.io/duckduckgo/microsoft.com)\n\n### Email\n\nResolve user avatars from an email address with a single URL. The `/email/:key` route uses the same provider chain as a bare `/user@domain` path: the service tries Gravatar, GitHub in order until one returns an image. No API keys and no SDK are required.\n\nWhen the path looks like an email, unavatar walks that chain until a provider succeeds. You can also skip the chain and call a named email provider directly when you know where the avatar should come from.\n\nAutomatic resolution\n\nPass the address as the only path segment, or prefix it with `email/`. The API auto-detects email-shaped inputs and runs the same chain (Gravatar, GitHub).\n\n- Typed route `unavatar.io/email/{email}`: [unavatar.io/email/hello@microlink.io](https://unavatar.io/email/hello@microlink.io)\n- Bare path `unavatar.io/{email}`: [unavatar.io/hello@microlink.io](https://unavatar.io/hello@microlink.io)\n\nExplicit providers\n\nTarget a specific provider when you know where the avatar comes from.\n\n- Gravatar (`unavatar.io/gravatar/{email-or-hash}`) — email is normalized and SHA-256 hashed; 64-hex SHA-256 or 32-hex MD5 passes through. Example: [unavatar.io/gravatar/hello@microlink.io](https://unavatar.io/gravatar/hello@microlink.io)\n- GitHub (`unavatar.io/github/{email}`) — public profile email or commit history: [unavatar.io/github/sindresorhus@gmail.com](https://unavatar.io/github/sindresorhus@gmail.com)\n\ne.g., [unavatar.io/email/hello@microlink.io](https://unavatar.io/email/hello@microlink.io)\n\n### Facebook\n\nGet any Facebook user, page, or group profile picture by their username or ID.\n\nAvailable inputs:\n\n- Username, e.g., [unavatar.io/facebook/zuck](https://unavatar.io/facebook/zuck)\n- Page, e.g., [unavatar.io/facebook/windtodayco](https://unavatar.io/facebook/windtodayco)\n- Group ID, e.g., [unavatar.io/facebook/1426378481098002](https://unavatar.io/facebook/1426378481098002)\n\n### Flickr\n\nGet any Flickr user's buddy icon or group icon by username or group slug.\n\nThe input supports a URI format `type:id`.\n\nWhen no type is provided, it defaults to `user` (user profile).\n\nAvailable inputs:\n\n- `user` (default): [unavatar.io/flickr/user:elizabethgadd](https://unavatar.io/flickr/user:elizabethgadd)\n- `group`: [unavatar.io/flickr/group:allthingsearthy](https://unavatar.io/flickr/group:allthingsearthy)\n\n### GitHub\n\nGet any GitHub user or organization's profile picture by username, or resolve an avatar from a public email via GitHub search when the address matches a profile or commit history.\n\nAvailable inputs:\n\n- User, e.g., [unavatar.io/github/mdo](https://unavatar.io/github/mdo)\n- Organization, e.g., [unavatar.io/github/vercel](https://unavatar.io/github/vercel)\n- Email address, e.g., [unavatar.io/github/sindresorhus@gmail.com](https://unavatar.io/github/sindresorhus@gmail.com)\n\n### GitLab\n\nGet any GitLab user or organization's profile picture by their username.\n\nAvailable inputs:\n\n- User, e.g., [unavatar.io/gitlab/sytses](https://unavatar.io/gitlab/sytses)\n- Organization, e.g., [unavatar.io/gitlab/inkscape](https://unavatar.io/gitlab/inkscape)\n\n### Google\n\nGet the favicon or logo for any domain using Google's favicon service.\n\ne.g., [unavatar.io/google/stremio.com](https://unavatar.io/google/stremio.com)\n\n### Google Play\n\nGet the icon for any Android app on Google Play by its package name, or get a developer icon by numeric ID.\n\nThe input supports a URI format `type:id`.\n\nWhen no type is provided, the input is treated as a package name (`app`).\n\nAvailable inputs:\n\n- `app` (default): [unavatar.io/google-play/app:com.devolver.grispaid](https://unavatar.io/google-play/app:com.devolver.grispaid)\n- `dev`: [unavatar.io/google-play/dev:6592603558263828430](https://unavatar.io/google-play/dev:6592603558263828430)\n\n### Gravatar\n\nResolve avatars via Gravatar using a plain email or a precomputed hash. Emails are trimmed, lowercased, and hashed with SHA-256 for the Gravatar URL; 64-hex SHA-256 and 32-hex MD5 values are passed through (normalized to lowercase).\n\nAvailable inputs:\n\n- Email address, e.g., [unavatar.io/gravatar/hello@microlink.io](https://unavatar.io/gravatar/hello@microlink.io)\n- SHA-256 hash, e.g., [unavatar.io/gravatar/b1f507c7a29adfa84eaa521036774b0577c58f23f2f3f42e068d6ac256cffae2](https://unavatar.io/gravatar/b1f507c7a29adfa84eaa521036774b0577c58f23f2f3f42e068d6ac256cffae2)\n- MD5 hash, e.g., [unavatar.io/gravatar/3f293df98a473eae038deabe430a1e30](https://unavatar.io/gravatar/3f293df98a473eae038deabe430a1e30)\n\nWhen you pass an email address directly in the URL, it is visible in plain text — both in server logs and to any intermediary that inspects the request.\n\nTo avoid this, pass a pre-computed `MD5` or `SHA256` hash of the email instead. Unavatar detects the hash automatically and routes it to Gravatar, which natively supports both hash formats.\n\n### Instagram\n\nGet any Instagram user's profile picture by their username. No authentication or API tokens needed — just pass the username.\n\ne.g., [unavatar.io/instagram/willsmith](https://unavatar.io/instagram/willsmith)\n\n### Ko-fi\n\nGet any Ko-fi page's profile picture by the creator username.\n\ne.g., [unavatar.io/ko-fi/geekshock](https://unavatar.io/ko-fi/geekshock)\n\n### LinkedIn\n\nGet any LinkedIn user or company profile picture by username or company slug.\n\nThe endpoint supports explicit type as part of the input.\n\nAvailable inputs:\n\n- `user` (default): [unavatar.io/linkedin/user:wesbos](https://unavatar.io/linkedin/user:wesbos)\n- `company`: [unavatar.io/linkedin/company:microlinkhq](https://unavatar.io/linkedin/company:microlinkhq)\n\n### Mastodon\n\nGet any Mastodon user's profile picture from any instance using the public account lookup API. Pass the handle as `user@server` so the account resolves on the correct home instance.\n\ne.g., [unavatar.io/mastodon/kpwags@hachyderm.io](https://unavatar.io/mastodon/kpwags@hachyderm.io)\n\n### Medium\n\nGet any Medium author's profile picture by their username.\n\ne.g., [unavatar.io/medium/juancalmaraz](https://unavatar.io/medium/juancalmaraz)\n\n### Microlink\n\nExtract the logo or representative image from any URL. The page is rendered and the best available image is selected — useful for getting brand logos from any website.\n\ne.g., [unavatar.io/microlink/microlink.io](https://unavatar.io/microlink/microlink.io)\n\n### OnlyFans\n\nGet any OnlyFans creator's profile picture by their username.\n\ne.g., [unavatar.io/onlyfans/amandaribas](https://unavatar.io/onlyfans/amandaribas)\n\n### OpenStreetMap\n\nGet any OpenStreetMap contributor's profile picture. Accepts either a numeric user ID or a username.\n\nAvailable inputs:\n\n- Numeric user ID, e.g., [unavatar.io/openstreetmap/98672](https://unavatar.io/openstreetmap/98672)\n- Username, e.g., [unavatar.io/openstreetmap/Terence%20Eden](https://unavatar.io/openstreetmap/Terence%20Eden)\n\n### Patreon\n\nGet any Patreon creator's profile picture by their username.\n\ne.g., [unavatar.io/patreon/gametestro](https://unavatar.io/patreon/gametestro)\n\n### Pinterest\n\nGet any Pinterest user's profile picture by their username.\n\ne.g., [unavatar.io/pinterest/ohjoy](https://unavatar.io/pinterest/ohjoy)\n\n### Printables\n\nGet any Printables user's profile picture by their username.\n\ne.g., [unavatar.io/printables/DukeDoks](https://unavatar.io/printables/DukeDoks)\n\n### PSN Profiles\n\nGet any PlayStation Network user's profile picture by their PSN username.\n\ne.g., [unavatar.io/psnprofiles/Duff85](https://unavatar.io/psnprofiles/Duff85)\n\n### Reddit\n\nGet any Reddit user's avatar by their username.\n\nAvailable inputs:\n\n- Username, e.g., [unavatar.io/reddit/thisisbillgates](https://unavatar.io/reddit/thisisbillgates)\n- Organization, e.g., [unavatar.io/reddit/nasa](https://unavatar.io/reddit/nasa)\n\n### Snapchat\n\nGet any Snapchat user's profile picture by their username.\n\ne.g., [unavatar.io/snapchat/teddysdaytoday](https://unavatar.io/snapchat/teddysdaytoday)\n\n### SoundCloud\n\nGet any SoundCloud artist's profile picture by their username.\n\ne.g., [unavatar.io/soundcloud/gorillaz](https://unavatar.io/soundcloud/gorillaz)\n\n### Spotify\n\nGet artwork for any Spotify entity — users, artists, albums, playlists, shows, episodes, or tracks. Look up by username or Spotify ID.\n\nThe endpoint supports explicit type as part of the input.\n\nIf explicit type is not provided, it defaults to `user`.\n\nAvailable inputs:\n\n- `album`: [unavatar.io/spotify/album:7I9Wh2IgvI3Nnr8Z1ZSWby](https://unavatar.io/spotify/album:7I9Wh2IgvI3Nnr8Z1ZSWby)\n- `artist`: [unavatar.io/spotify/artist:1vCWHaC5f2uS3yhpwWbIA6](https://unavatar.io/spotify/artist:1vCWHaC5f2uS3yhpwWbIA6)\n- `episode`: [unavatar.io/spotify/episode:1YNm34Q8ofC2CDTYYLaFMj](https://unavatar.io/spotify/episode:1YNm34Q8ofC2CDTYYLaFMj)\n- `playlist`: [unavatar.io/spotify/playlist:37i9dQZF1DZ06evO3KIUZW](https://unavatar.io/spotify/playlist:37i9dQZF1DZ06evO3KIUZW)\n- `show`: [unavatar.io/spotify/show:0iykbhPkRz53QF8LR2UyNO](https://unavatar.io/spotify/show:0iykbhPkRz53QF8LR2UyNO)\n- `track`: [unavatar.io/spotify/track:4OROzZUy6gOWN4UGQVaZMF](https://unavatar.io/spotify/track:4OROzZUy6gOWN4UGQVaZMF)\n- `user` (default): [unavatar.io/spotify/user:kikobeats](https://unavatar.io/spotify/user:kikobeats)\n\n### Stack Overflow\n\nGet any Stack Overflow user's profile picture by their numeric user ID only (slug paths are not supported).\n\ne.g., [unavatar.io/stackoverflow/19082](https://unavatar.io/stackoverflow/19082)\n\n### Steam\n\nGet any Steam player or community group profile picture by public profile name, numeric account ID, or group name.\n\nThe input supports a URI format `type:value`.\n\nWhen no type is provided, it defaults to `id` (player profile name).\n\nAvailable inputs:\n\n- `id` (default): [unavatar.io/steam/id:gabelogannewell](https://unavatar.io/steam/id:gabelogannewell)\n- `profile`: [unavatar.io/steam/profile:76561198044605749](https://unavatar.io/steam/profile:76561198044605749)\n- `group`: [unavatar.io/steam/group:murcia-gaming](https://unavatar.io/steam/group:murcia-gaming)\n\n### Substack\n\nGet any Substack author's profile picture by their publication username.\n\ne.g., [unavatar.io/substack/bankless](https://unavatar.io/substack/bankless)\n\n### Telegram\n\nGet any Telegram user's profile picture by their username.\n\ne.g., [unavatar.io/telegram/drsdavidsoft](https://unavatar.io/telegram/drsdavidsoft)\n\n### Threads\n\nGet any Threads user's profile picture by their username.\n\ne.g., [unavatar.io/threads/zuck](https://unavatar.io/threads/zuck)\n\n### TikTok\n\nGet any TikTok user's profile picture by their username. No authentication or API tokens needed — just pass the username.\n\ne.g., [unavatar.io/tiktok/carlosazaustre](https://unavatar.io/tiktok/carlosazaustre)\n\n### Tumblr\n\nGet any Tumblr blog's profile picture by their username.\n\ne.g., [unavatar.io/tumblr/nasa](https://unavatar.io/tumblr/nasa)\n\n### Twitch\n\nGet any Twitch streamer's profile picture by their username.\n\ne.g., [unavatar.io/twitch/midudev](https://unavatar.io/twitch/midudev)\n\n### Vimeo\n\nGet any Vimeo user's profile picture by their username.\n\ne.g., [unavatar.io/vimeo/ladieswithlenses](https://unavatar.io/vimeo/ladieswithlenses)\n\n### WhatsApp\n\nGet the profile picture for a WhatsApp channel or chat by ID.\n\nThe input supports a URI format `type:id`.\n\nIf no type is provided, the input is treated as a phone number.\n\nAvailable inputs:\n\n- `phone`: [unavatar.io/whatsapp/phone:34660021551](https://unavatar.io/whatsapp/phone:34660021551)\n- `channel`: [unavatar.io/whatsapp/channel:0029VaARuQ7KwqSXh9fiMc0m](https://unavatar.io/whatsapp/channel:0029VaARuQ7KwqSXh9fiMc0m)\n- `chat`: [unavatar.io/whatsapp/chat:D2FFycjQXrEIKG8qQjbwZz](https://unavatar.io/whatsapp/chat:D2FFycjQXrEIKG8qQjbwZz)\n\n### X/Twitter\n\nGet any X (formerly Twitter) user's profile picture by their username.\n\ne.g., [unavatar.io/x/elonmusk](https://unavatar.io/x/elonmusk)\n\n### Xbox Gamertag\n\nGet any Xbox player's profile picture by their gamertag.\n\ne.g., [unavatar.io/xboxgamertag/GD-BerserkerTTD](https://unavatar.io/xboxgamertag/GD-BerserkerTTD)\n\n### YouTube\n\nGet any YouTube channel's thumbnail by their handle, legacy username, or channel ID.\n\nThe endpoint supports specific input formats.\n\nIf the input starts with `UC` and has 24 characters, it is treated as a channel ID. Otherwise, it is treated as a handle.\n\nAvailable inputs:\n\n- `username`: [unavatar.io/youtube/casey](https://unavatar.io/youtube/casey)\n- `channel`: [unavatar.io/youtube/UC_x5XG1OV2P6uZZ5FSM9Ttw](https://unavatar.io/youtube/UC_x5XG1OV2P6uZZ5FSM9Ttw)\n\n## Response Format\n\nA response is returning the user avatar by default.\n\nHowever, you can get a [json](https://unavatar.io/docs#json) as response payload.\n\nWhen an endpoint returns JSON, the shape is predictable so you can parse it reliably in your app:\n\n| Field     | Type           | Present in                      | Description                                      |\n| --------- | -------------- | ------------------------------- | ------------------------------------------------ |\n| `status`  | `string`       | all JSON responses              | One of: `success`, `fail`, `error`.              |\n| `message` | `string`       | all JSON responses              | Human-readable summary for display/logging.      |\n| `data`    | `object`       | `success`                       | Response payload for successful requests.        |\n| `code`    | `string`       | `fail`, `error`                 | Stable machine-readable error code.              |\n| `more`    | `string (URL)` | most `fail` / `error` responses | Documentation URL with troubleshooting details.  |\n| `report`  | `string`       | some `error` responses          | Support contact channel (for example `mailto:`). |\n\n## Response Headers\n\nThese headers help you understand pricing, limits, and request diagnostics.\n\n| Header                   | Purpose                                                   |\n| ------------------------ | --------------------------------------------------------- |\n| `x-pricing-tier`         | `free` or `pro` — the plan used for this request          |\n| `x-timestamp`            | Server timestamp when request was received                |\n| `x-unavatar-cost`        | Token cost of the request (avatar routes only)            |\n| `x-proxy-tier`           | Proxy tier used: `origin`, `datacenter`, or `residential` |\n| `x-rate-limit-limit`     | Maximum requests allowed per window (free tier only)      |\n| `x-rate-limit-remaining` | Remaining requests in current window (free tier only)     |\n| `x-rate-limit-reset`     | UTC epoch seconds when window resets (free tier only)     |\n| `retry-after`            | Seconds until rate limit resets (only on 429 responses)   |\n\n```bash\n$ curl -I -H \"x-api-key: YOUR_API_KEY\" https://unavatar.io/github/kikobeats\n\nx-pricing-tier: pro\n\nx-timestamp: 1744209600\n\nx-unavatar-cost: 1\n\nx-proxy-tier: origin\n\nx-rate-limit-limit: 50\n\nx-rate-limit-remaining: 49\n\nx-rate-limit-reset: 1744243200\n```\n\n## Response Errors\n\nExpected errors are known operational cases returned with stable codes.\n\n- **Client-side issues** return `status: \"fail\"` (HTTP `4xx`).\n- **Service-side issues** return `status: \"error\"` (HTTP `5xx`).\n- Unknown failures return `EINTERNAL` (HTTP `500`).\n- Use the `code` for programmatic handling in clients.\n- Use the `message` to show user-facing feedback.\n- `more` links to documentation for common fixes.\n- `report` (when present) indicates how to contact support for server errors.\n\n| HTTP | Code                 | Typical trigger                             |\n| ---- | -------------------- | ------------------------------------------- |\n| 400  | `ESESSIONID`         | Missing `session_id` in `/checkout/success` |\n| 400  | `ESESSION`           | Checkout session not paid or not found      |\n| 400  | `ESIGNATURE`         | Missing `stripe-signature` header           |\n| 400  | `EWEBHOOK`           | Invalid/failed Stripe webhook processing    |\n| 400  | `EAPIKEYVALUE`       | Missing `apiKey` query parameter            |\n| 400  | `EAPIKEYLABEL`       | Missing `label` query parameter             |\n| 401  | `EEMAIL`             | Invalid or missing authenticated email      |\n| 401  | `EUSERUNAUTHORIZED`  | Missing/invalid auth for protected routes   |\n| 401  | `EAPIKEY`            | Invalid `x-api-key`                         |\n| 403  | `ETTL`               | Custom `ttl` requested without pro plan     |\n| 403  | `EPRO`               | Provider restricted to pro plan             |\n| 404  | `ENOTFOUND`          | Route not found                             |\n| 404  | `EAPIKEYNOTFOUND`    | API key not found                           |\n| 409  | `EAPIKEYEXISTS`      | Custom API key already exists               |\n| 409  | `EAPIKEYLABELEXISTS` | API key label already exists                |\n| 409  | `EAPIKEYMIN`         | Attempt to remove last remaining key        |\n| 429  | `ERATE`              | Anonymous daily rate limit exceeded         |\n| 500  | `ECHECKOUT`          | Stripe checkout session creation failed     |\n| 500  | `EAPIKEYFAILED`      | API key retrieval after checkout failed     |\n| 500  | `EINTERNAL`          | Unexpected internal server failure          |\n\n## Contact\n\nIf you have a suggestion or need to report a bug, contact us at \u003chello@unavatar.io\u003e.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrolinkhq%2Funavatar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrolinkhq%2Funavatar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrolinkhq%2Funavatar/lists"}