@unavatar/core 3.19.1 → 3.19.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +47 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -19,10 +19,12 @@
19
19
  - [Discord](#discord)
20
20
  - [Dribbble](#dribbble)
21
21
  - [DuckDuckGo](#duckduckgo)
22
+ - [Facebook](#facebook)
22
23
  - [GitHub](#github)
23
24
  - [GitLab](#gitlab)
24
25
  - [LinkedIn](#linkedin)
25
26
  - [Google](#google)
27
+ - [Gravatar](#gravatar)
26
28
  - [Instagram](#instagram)
27
29
  - [Ko-fi](#ko-fi)
28
30
  - [Medium](#medium)
@@ -33,6 +35,7 @@
33
35
  - [Patreon](#patreon)
34
36
  - [Pinterest](#pinterest)
35
37
  - [Printables](#printables)
38
+ - [PSN Profiles](#psn-profiles)
36
39
  - [Reddit](#reddit)
37
40
  - [Snapchat](#snapchat)
38
41
  - [SoundCloud](#soundcloud)
@@ -42,12 +45,16 @@
42
45
  - [Telegram](#telegram)
43
46
  - [Threads](#threads)
44
47
  - [TikTok](#tiktok)
48
+ - [Tumblr](#tumblr)
45
49
  - [Twitch](#twitch)
46
50
  - [Vimeo](#vimeo)
47
51
  - [WhatsApp](#whatsapp)
52
+ - [X/Twitter](#xtwitter)
53
+ - [Xbox Gamertag](#xbox-gamertag)
48
54
  - [YouTube](#youtube)
49
55
  - [Response Format](#response-format)
50
56
  - [Response Headers](#response-headers)
57
+ - [Response Errors](#response-errors)
51
58
 
52
59
  ---
53
60
 
@@ -55,14 +62,6 @@
55
62
 
56
63
  Welcome to **unavatar.io**, the ultimate avatar service that offers everything you need to easily retrieve user avatars:
57
64
 
58
- - **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.
59
-
60
- - **Speed**: Designed to be fast and efficient with a 93% cache hit rate, serving 21.7 TB of data across 728M requests.
61
-
62
- - **Optimize**: All the images are not only compressed on-the-fly to reduce their size and save bandwith, but also optimized to maintain a high-quality ratio. They are ready for immediate use, enhancing the overall optimization of your website or application.
63
-
64
- - **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.
65
-
66
65
  It'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.
67
66
 
68
67
  ## Quick start
@@ -350,6 +349,16 @@ Available inputs:
350
349
 
351
350
  - Domain, e.g., [unavatar.io/duckduckgo/microsoft.com](https://unavatar.io/duckduckgo/microsoft.com)
352
351
 
352
+ ### Facebook
353
+
354
+ Get any Facebook user, page, or group profile picture by their username or ID.
355
+
356
+ Available inputs:
357
+
358
+ - Username, e.g., [unavatar.io/facebook/zuck](https://unavatar.io/facebook/zuck)
359
+ - Page, e.g., [unavatar.io/facebook/windtodayco](https://unavatar.io/facebook/windtodayco)
360
+ - Group ID, e.g., [unavatar.io/facebook/1426378481098002](https://unavatar.io/facebook/1426378481098002)
361
+
353
362
  ### GitHub
354
363
 
355
364
  Get any GitHub user or organization's profile picture by their username.
@@ -391,6 +400,8 @@ Available inputs:
391
400
 
392
401
  - Domain, e.g., [unavatar.io/google/stremio.com](https://unavatar.io/google/stremio.com)
393
402
 
403
+ ### Gravatar
404
+
394
405
  Get any user's avatar by their email address via Gravatar. The most widely used global avatar service — if your users have a Gravatar set up, this is the fastest way to retrieve it.
395
406
 
396
407
  Available inputs:
@@ -478,6 +489,14 @@ Available inputs:
478
489
 
479
490
  - Username, e.g., [unavatar.io/printables/DukeDoks](https://unavatar.io/printables/DukeDoks)
480
491
 
492
+ ### PSN Profiles
493
+
494
+ Get any PlayStation Network user's profile picture by their PSN username.
495
+
496
+ Available inputs:
497
+
498
+ - Username, e.g., [unavatar.io/psnprofiles/P3](https://unavatar.io/psnprofiles/P3)
499
+
481
500
  ### Reddit
482
501
 
483
502
  Get any Reddit user's avatar by their username.
@@ -571,6 +590,14 @@ Available inputs:
571
590
 
572
591
  - Username, e.g., [unavatar.io/tiktok/carlosazaustre](https://unavatar.io/tiktok/carlosazaustre)
573
592
 
593
+ ### Tumblr
594
+
595
+ Get any Tumblr blog's profile picture by their username.
596
+
597
+ Available inputs:
598
+
599
+ - Username, e.g., [unavatar.io/tumblr/nasa](https://unavatar.io/tumblr/nasa)
600
+
574
601
  ### Twitch
575
602
 
576
603
  Get any Twitch streamer's profile picture by their username.
@@ -603,12 +630,22 @@ Available URI format inputs:
603
630
  - `channel`: [unavatar.io/whatsapp/channel:0029VaARuQ7KwqSXh9fiMc0m](https://unavatar.io/whatsapp/channel:0029VaARuQ7KwqSXh9fiMc0m)
604
631
  - `chat`: [unavatar.io/whatsapp/chat:D2FFycjQXrEIKG8qQjbwZz](https://unavatar.io/whatsapp/chat:D2FFycjQXrEIKG8qQjbwZz)
605
632
 
633
+ ### X/Twitter
634
+
606
635
  Get any X (formerly Twitter) user's profile picture by their username.
607
636
 
608
637
  Available inputs:
609
638
 
610
639
  - Username, e.g., [unavatar.io/x/elonmusk](https://unavatar.io/x/elonmusk)
611
640
 
641
+ ### Xbox Gamertag
642
+
643
+ Get any Xbox player's profile picture by their gamertag.
644
+
645
+ Available inputs:
646
+
647
+ - Gamertag, e.g., [unavatar.io/xboxgamertag/P3](https://unavatar.io/xboxgamertag/P3)
648
+
612
649
  ### YouTube
613
650
 
614
651
  Get any YouTube channel's thumbnail by their handle, legacy username, or channel ID.
@@ -668,6 +705,8 @@ x-rate-limit-remaining: 49
668
705
  x-rate-limit-reset: 1744243200
669
706
  ```
670
707
 
708
+ ## Response Errors
709
+
671
710
  Expected errors are known operational cases returned with stable codes.
672
711
 
673
712
  - **Client-side issues** return `status: "fail"` (HTTP `4xx`).
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@unavatar/core",
3
3
  "description": "Get unified user avatar from social networks, including Instagram, SoundCloud, Telegram, Twitter, YouTube & more.",
4
4
  "homepage": "https://unavatar.io",
5
- "version": "3.19.1",
5
+ "version": "3.19.2",
6
6
  "main": "src/index.js",
7
7
  "exports": {
8
8
  ".": "./src/index.js",