@unavatar/core 3.25.3 → 3.25.5

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 +130 -105
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -13,23 +13,29 @@
13
13
  - [JSON](#json)
14
14
  - [Providers](#providers)
15
15
  - [Apple Music](#apple-music)
16
+ - [Apple Store](#apple-store)
16
17
  - [Behance](#behance)
17
18
  - [Bluesky](#bluesky)
19
+ - [Buy Me a Coffee](#buy-me-a-coffee)
18
20
  - [DeviantArt](#deviantart)
19
21
  - [Discord](#discord)
22
+ - [Domain](#domain)
20
23
  - [Dribbble](#dribbble)
21
24
  - [DuckDuckGo](#duckduckgo)
25
+ - [Email](#email)
22
26
  - [Facebook](#facebook)
27
+ - [Flickr](#flickr)
23
28
  - [GitHub](#github)
24
29
  - [GitLab](#gitlab)
25
- - [LinkedIn](#linkedin)
26
30
  - [Google](#google)
31
+ - [Google Play](#google-play)
27
32
  - [Gravatar](#gravatar)
28
33
  - [Instagram](#instagram)
29
34
  - [Ko-fi](#ko-fi)
35
+ - [LinkedIn](#linkedin)
36
+ - [Mastodon](#mastodon)
30
37
  - [Medium](#medium)
31
38
  - [Microlink](#microlink)
32
- - [Mastodon](#mastodon)
33
39
  - [OnlyFans](#onlyfans)
34
40
  - [OpenStreetMap](#openstreetmap)
35
41
  - [Patreon](#patreon)
@@ -40,6 +46,7 @@
40
46
  - [Snapchat](#snapchat)
41
47
  - [SoundCloud](#soundcloud)
42
48
  - [Spotify](#spotify)
49
+ - [Stack Overflow](#stack-overflow)
43
50
  - [Steam](#steam)
44
51
  - [Substack](#substack)
45
52
  - [Telegram](#telegram)
@@ -70,12 +77,15 @@ The service is exposed in **unavatar.io** via provider endpoints:
70
77
 
71
78
  - an **email (auto-detect)**: [unavatar.io/hello@microlink.io](https://unavatar.io/hello@microlink.io) — tries Gravatar, then GitHub
72
79
  - an **email** via Gravatar: [unavatar.io/gravatar/hello@microlink.io](https://unavatar.io/gravatar/hello@microlink.io)
80
+ - a **Gravatar SHA-256** (same email, pre-hashed): [unavatar.io/gravatar/b1f507c7a29adfa84eaa521036774b0577c58f23f2f3f42e068d6ac256cffae2](https://unavatar.io/gravatar/b1f507c7a29adfa84eaa521036774b0577c58f23f2f3f42e068d6ac256cffae2)
73
81
  - an **email** via GitHub: [unavatar.io/github/sindresorhus@gmail.com](https://unavatar.io/github/sindresorhus@gmail.com)
74
82
  - an **username**: [unavatar.io/github/kikobeats](https://unavatar.io/github/kikobeats)
75
83
  - a **domain**: [unavatar.io/google/reddit.com](https://unavatar.io/google/reddit.com)
76
84
 
77
85
  Use `/:provider/:key` for provider-specific lookups, or pass an email as the only path segment for automatic resolution. You can read more in [Email avatars](https://unavatar.io/email) and [providers](https://unavatar.io/docs#providers).
78
86
 
87
+ For **Gravatar**, `key` can be a plain email or a precomputed identifier: emails are trimmed, lowercased, and hashed with **SHA-256** before calling Gravatar. Values that already look like a **64-character hex SHA-256** or **32-character hex MD5** are sent as-is (hex is normalized to lowercase).
88
+
79
89
  ## Authentication
80
90
 
81
91
  Anonymous requests work without authentication. They are limited to 25 requests/day per IP address.
@@ -283,13 +293,11 @@ e.g., [unavatar.io/github/kikobeats?json](https://unavatar.io/github/kikobeats?j
283
293
 
284
294
  Get artwork for any Apple Music artist, album, or song. Search by name or look up directly by numeric Apple Music ID.
285
295
 
286
- e.g., [unavatar.io/apple-music/artist:daft%20punk](https://unavatar.io/apple-music/artist:daft%20punk)
287
-
288
296
  The endpoint supports explicit type as part of the input.
289
297
 
290
298
  If explicit type is not provided, it searches `artist` and `song` (in that order).
291
299
 
292
- Available URI format inputs:
300
+ Available inputs:
293
301
 
294
302
  - artist
295
303
  - by artist name: [unavatar.io/apple-music/artist:daft%20punk](https://unavatar.io/apple-music/artist:daft%20punk)
@@ -301,13 +309,24 @@ Available URI format inputs:
301
309
  - by song name: [unavatar.io/apple-music/song:harder%20better%20faster%20stronger](https://unavatar.io/apple-music/song:harder%20better%20faster%20stronger)
302
310
  - by song ID: [unavatar.io/apple-music/song:697195787](https://unavatar.io/apple-music/song:697195787)
303
311
 
304
- ### Behance
312
+ ### Apple Store
305
313
 
306
- Get any Behance user's profile picture by their username.
314
+ Get the icon for any iOS or macOS app on the App Store by numeric Apple ID.
315
+
316
+ The endpoint supports explicit type as part of the input.
317
+
318
+ If explicit type is not provided, it defaults to `id`.
307
319
 
308
320
  Available inputs:
309
321
 
310
- - Username, e.g., [unavatar.io/behance/vitormatosinhos](https://unavatar.io/behance/vitormatosinhos)
322
+ - `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)
323
+ - `name`: [unavatar.io/apple-store/name:pokemon%20go](https://unavatar.io/apple-store/name:pokemon%20go)
324
+
325
+ ### Behance
326
+
327
+ Get any Behance user's profile picture by their username.
328
+
329
+ e.g., [unavatar.io/behance/vitormatosinhos](https://unavatar.io/behance/vitormatosinhos)
311
330
 
312
331
  ### Bluesky
313
332
 
@@ -318,13 +337,17 @@ Available inputs:
318
337
  - User handle, e.g., [unavatar.io/bluesky/pfrazee.com](https://unavatar.io/bluesky/pfrazee.com)
319
338
  - Domain handle, e.g., [unavatar.io/bluesky/bsky.app](https://unavatar.io/bluesky/bsky.app)
320
339
 
340
+ ### Buy Me a Coffee
341
+
342
+ Get any Buy Me a Coffee creator's profile picture by their username.
343
+
344
+ e.g., [unavatar.io/buymeacoffee/mikebarnesdrums](https://unavatar.io/buymeacoffee/mikebarnesdrums)
345
+
321
346
  ### DeviantArt
322
347
 
323
348
  Get any DeviantArt user's profile picture by their username.
324
349
 
325
- Available inputs:
326
-
327
- - Username, e.g., [unavatar.io/deviantart/spyed](https://unavatar.io/deviantart/spyed)
350
+ e.g., [unavatar.io/deviantart/spyed](https://unavatar.io/deviantart/spyed)
328
351
 
329
352
  ### Discord
330
353
 
@@ -335,21 +358,45 @@ Available inputs:
335
358
  - Server name, e.g., [unavatar.io/discord/lilnasx](https://unavatar.io/discord/lilnasx)
336
359
  - Server ID, e.g., [unavatar.io/discord/uW6Hyf3E9r](https://unavatar.io/discord/uW6Hyf3E9r)
337
360
 
361
+ ### Domain
362
+
363
+ Retrieve 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.
364
+
365
+ e.g., [unavatar.io/domain/microlink.io](https://unavatar.io/domain/microlink.io)
366
+
338
367
  ### Dribbble
339
368
 
340
369
  Get any Dribbble designer's profile picture by their username.
341
370
 
342
- Available inputs:
343
-
344
- - Username, e.g., [unavatar.io/dribbble/omidnikrah](https://unavatar.io/dribbble/omidnikrah)
371
+ e.g., [unavatar.io/dribbble/omidnikrah](https://unavatar.io/dribbble/omidnikrah)
345
372
 
346
373
  ### DuckDuckGo
347
374
 
348
375
  Get 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.
349
376
 
350
- Available inputs:
377
+ e.g., [unavatar.io/duckduckgo/microsoft.com](https://unavatar.io/duckduckgo/microsoft.com)
378
+
379
+ ### Email
380
+
381
+ Resolve 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.
382
+
383
+ When 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.
351
384
 
352
- - Domain, e.g., [unavatar.io/duckduckgo/microsoft.com](https://unavatar.io/duckduckgo/microsoft.com)
385
+ Automatic resolution
386
+
387
+ Pass 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).
388
+
389
+ - Typed route `unavatar.io/email/{email}`: [unavatar.io/email/hello@microlink.io](https://unavatar.io/email/hello@microlink.io)
390
+ - Bare path `unavatar.io/{email}`: [unavatar.io/hello@microlink.io](https://unavatar.io/hello@microlink.io)
391
+
392
+ Explicit providers
393
+
394
+ Target a specific provider when you know where the avatar comes from.
395
+
396
+ - 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)
397
+ - GitHub (`unavatar.io/github/{email}`) — public profile email or commit history: [unavatar.io/github/sindresorhus@gmail.com](https://unavatar.io/github/sindresorhus@gmail.com)
398
+
399
+ e.g., [unavatar.io/email/hello@microlink.io](https://unavatar.io/email/hello@microlink.io)
353
400
 
354
401
  ### Facebook
355
402
 
@@ -361,6 +408,19 @@ Available inputs:
361
408
  - Page, e.g., [unavatar.io/facebook/windtodayco](https://unavatar.io/facebook/windtodayco)
362
409
  - Group ID, e.g., [unavatar.io/facebook/1426378481098002](https://unavatar.io/facebook/1426378481098002)
363
410
 
411
+ ### Flickr
412
+
413
+ Get any Flickr user's buddy icon or group icon by username or group slug.
414
+
415
+ The input supports a URI format `type:id`.
416
+
417
+ When no type is provided, it defaults to `user` (user profile).
418
+
419
+ Available inputs:
420
+
421
+ - `user` (default): [unavatar.io/flickr/user:elizabethgadd](https://unavatar.io/flickr/user:elizabethgadd)
422
+ - `group`: [unavatar.io/flickr/group:allthingsearthy](https://unavatar.io/flickr/group:allthingsearthy)
423
+
364
424
  ### GitHub
365
425
 
366
426
  Get 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.
@@ -380,84 +440,81 @@ Available inputs:
380
440
  - User, e.g., [unavatar.io/gitlab/sytses](https://unavatar.io/gitlab/sytses)
381
441
  - Organization, e.g., [unavatar.io/gitlab/inkscape](https://unavatar.io/gitlab/inkscape)
382
442
 
383
- ### LinkedIn
384
-
385
- Get any LinkedIn user or company profile picture by username or company slug.
443
+ ### Google
386
444
 
387
- e.g., [unavatar.io/linkedin/user:wesbos](https://unavatar.io/linkedin/user:wesbos)
445
+ Get the favicon or logo for any domain using Google's favicon service.
388
446
 
389
- The input supports a URI format `type:id`.
447
+ e.g., [unavatar.io/google/stremio.com](https://unavatar.io/google/stremio.com)
390
448
 
391
- When no type is provided, it defaults to `user` (user profile).
449
+ ### Google Play
392
450
 
393
- Available URI format inputs:
451
+ Get the icon for any Android app on Google Play by its package name, or get a developer icon by numeric ID.
394
452
 
395
- - `user` (default): [unavatar.io/linkedin/user:wesbos](https://unavatar.io/linkedin/user:wesbos)
396
- - `company`: [unavatar.io/linkedin/company:microlinkhq](https://unavatar.io/linkedin/company:microlinkhq)
397
-
398
- ### Google
453
+ The input supports a URI format `type:id`.
399
454
 
400
- Get the favicon or logo for any domain using Google's favicon service.
455
+ When no type is provided, the input is treated as a package name (`app`).
401
456
 
402
457
  Available inputs:
403
458
 
404
- - Domain, e.g., [unavatar.io/google/stremio.com](https://unavatar.io/google/stremio.com)
459
+ - `app` (default): [unavatar.io/google-play/app:com.devolver.grispaid](https://unavatar.io/google-play/app:com.devolver.grispaid)
460
+ - `dev`: [unavatar.io/google-play/dev:6592603558263828430](https://unavatar.io/google-play/dev:6592603558263828430)
405
461
 
406
462
  ### Gravatar
407
463
 
408
- 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.
464
+ Resolve 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).
409
465
 
410
466
  Available inputs:
411
467
 
412
468
  - Email address, e.g., [unavatar.io/gravatar/hello@microlink.io](https://unavatar.io/gravatar/hello@microlink.io)
469
+ - SHA-256 hash, e.g., [unavatar.io/gravatar/b1f507c7a29adfa84eaa521036774b0577c58f23f2f3f42e068d6ac256cffae2](https://unavatar.io/gravatar/b1f507c7a29adfa84eaa521036774b0577c58f23f2f3f42e068d6ac256cffae2)
470
+ - MD5 hash, e.g., [unavatar.io/gravatar/3f293df98a473eae038deabe430a1e30](https://unavatar.io/gravatar/3f293df98a473eae038deabe430a1e30)
413
471
 
414
472
  ### Instagram
415
473
 
416
474
  Get any Instagram user's profile picture by their username. No authentication or API tokens needed — just pass the username.
417
475
 
418
- Available inputs:
419
-
420
- - Username, e.g., [unavatar.io/instagram/willsmith](https://unavatar.io/instagram/willsmith)
476
+ e.g., [unavatar.io/instagram/willsmith](https://unavatar.io/instagram/willsmith)
421
477
 
422
478
  ### Ko-fi
423
479
 
424
480
  Get any Ko-fi page's profile picture by the creator username.
425
481
 
426
- Available inputs:
482
+ e.g., [unavatar.io/ko-fi/geekshock](https://unavatar.io/ko-fi/geekshock)
427
483
 
428
- - Creator username, e.g., [unavatar.io/ko-fi/geekshock](https://unavatar.io/ko-fi/geekshock)
484
+ ### LinkedIn
429
485
 
430
- ### Medium
486
+ Get any LinkedIn user or company profile picture by username or company slug.
431
487
 
432
- Get any Medium author's profile picture by their username.
488
+ The endpoint supports explicit type as part of the input.
433
489
 
434
490
  Available inputs:
435
491
 
436
- - Username, e.g., [unavatar.io/medium/juancalmaraz](https://unavatar.io/medium/juancalmaraz)
492
+ - `user` (default): [unavatar.io/linkedin/user:wesbos](https://unavatar.io/linkedin/user:wesbos)
493
+ - `company`: [unavatar.io/linkedin/company:microlinkhq](https://unavatar.io/linkedin/company:microlinkhq)
437
494
 
438
- ### Microlink
495
+ ### Mastodon
439
496
 
440
- Extract 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.
497
+ Get 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.
441
498
 
442
- Available inputs:
499
+ e.g., [unavatar.io/mastodon/kpwags@hachyderm.io](https://unavatar.io/mastodon/kpwags@hachyderm.io)
443
500
 
444
- - Domain, e.g., [unavatar.io/microlink/microlink.io](https://unavatar.io/microlink/microlink.io)
501
+ ### Medium
445
502
 
446
- ### Mastodon
503
+ Get any Medium author's profile picture by their username.
447
504
 
448
- Get 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.
505
+ e.g., [unavatar.io/medium/juancalmaraz](https://unavatar.io/medium/juancalmaraz)
449
506
 
450
- Available inputs:
507
+ ### Microlink
508
+
509
+ Extract 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.
451
510
 
452
- - user@server, e.g., [unavatar.io/mastodon/kpwags@hachyderm.io](https://unavatar.io/mastodon/kpwags@hachyderm.io)
511
+ e.g., [unavatar.io/microlink/microlink.io](https://unavatar.io/microlink/microlink.io)
453
512
 
454
513
  ### OnlyFans
455
514
 
456
515
  Get any OnlyFans creator's profile picture by their username.
457
516
 
458
- Available inputs:
459
-
460
- - Username, e.g., [unavatar.io/onlyfans/amandaribas](https://unavatar.io/onlyfans/amandaribas)
517
+ e.g., [unavatar.io/onlyfans/amandaribas](https://unavatar.io/onlyfans/amandaribas)
461
518
 
462
519
  ### OpenStreetMap
463
520
 
@@ -472,33 +529,25 @@ Available inputs:
472
529
 
473
530
  Get any Patreon creator's profile picture by their username.
474
531
 
475
- Available inputs:
476
-
477
- - Username, e.g., [unavatar.io/patreon/gametestro](https://unavatar.io/patreon/gametestro)
532
+ e.g., [unavatar.io/patreon/gametestro](https://unavatar.io/patreon/gametestro)
478
533
 
479
534
  ### Pinterest
480
535
 
481
536
  Get any Pinterest user's profile picture by their username.
482
537
 
483
- Available inputs:
484
-
485
- - Username, e.g., [unavatar.io/pinterest/ohjoy](https://unavatar.io/pinterest/ohjoy)
538
+ e.g., [unavatar.io/pinterest/ohjoy](https://unavatar.io/pinterest/ohjoy)
486
539
 
487
540
  ### Printables
488
541
 
489
542
  Get any Printables user's profile picture by their username.
490
543
 
491
- Available inputs:
492
-
493
- - Username, e.g., [unavatar.io/printables/DukeDoks](https://unavatar.io/printables/DukeDoks)
544
+ e.g., [unavatar.io/printables/DukeDoks](https://unavatar.io/printables/DukeDoks)
494
545
 
495
546
  ### PSN Profiles
496
547
 
497
548
  Get any PlayStation Network user's profile picture by their PSN username.
498
549
 
499
- Available inputs:
500
-
501
- - Username, e.g., [unavatar.io/psnprofiles/Duff85](https://unavatar.io/psnprofiles/Duff85)
550
+ e.g., [unavatar.io/psnprofiles/Duff85](https://unavatar.io/psnprofiles/Duff85)
502
551
 
503
552
  ### Reddit
504
553
 
@@ -513,29 +562,23 @@ Available inputs:
513
562
 
514
563
  Get any Snapchat user's profile picture by their username.
515
564
 
516
- Available inputs:
517
-
518
- - Username, e.g., [unavatar.io/snapchat/teddysdaytoday](https://unavatar.io/snapchat/teddysdaytoday)
565
+ e.g., [unavatar.io/snapchat/teddysdaytoday](https://unavatar.io/snapchat/teddysdaytoday)
519
566
 
520
567
  ### SoundCloud
521
568
 
522
569
  Get any SoundCloud artist's profile picture by their username.
523
570
 
524
- Available inputs:
525
-
526
- - Username, e.g., [unavatar.io/soundcloud/gorillaz](https://unavatar.io/soundcloud/gorillaz)
571
+ e.g., [unavatar.io/soundcloud/gorillaz](https://unavatar.io/soundcloud/gorillaz)
527
572
 
528
573
  ### Spotify
529
574
 
530
575
  Get artwork for any Spotify entity — users, artists, albums, playlists, shows, episodes, or tracks. Look up by username or Spotify ID.
531
576
 
532
- e.g., [unavatar.io/spotify/album:7I9Wh2IgvI3Nnr8Z1ZSWby](https://unavatar.io/spotify/album:7I9Wh2IgvI3Nnr8Z1ZSWby)
533
-
534
577
  The endpoint supports explicit type as part of the input.
535
578
 
536
579
  If explicit type is not provided, it defaults to `user`.
537
580
 
538
- Available URI format inputs:
581
+ Available inputs:
539
582
 
540
583
  - `album`: [unavatar.io/spotify/album:7I9Wh2IgvI3Nnr8Z1ZSWby](https://unavatar.io/spotify/album:7I9Wh2IgvI3Nnr8Z1ZSWby)
541
584
  - `artist`: [unavatar.io/spotify/artist:1vCWHaC5f2uS3yhpwWbIA6](https://unavatar.io/spotify/artist:1vCWHaC5f2uS3yhpwWbIA6)
@@ -545,17 +588,21 @@ Available URI format inputs:
545
588
  - `track`: [unavatar.io/spotify/track:4OROzZUy6gOWN4UGQVaZMF](https://unavatar.io/spotify/track:4OROzZUy6gOWN4UGQVaZMF)
546
589
  - `user` (default): [unavatar.io/spotify/user:kikobeats](https://unavatar.io/spotify/user:kikobeats)
547
590
 
591
+ ### Stack Overflow
592
+
593
+ Get any Stack Overflow user's profile picture by their numeric user ID only (slug paths are not supported).
594
+
595
+ e.g., [unavatar.io/stackoverflow/19082](https://unavatar.io/stackoverflow/19082)
596
+
548
597
  ### Steam
549
598
 
550
599
  Get any Steam player or community group profile picture by public profile name, numeric account ID, or group name.
551
600
 
552
- e.g., [unavatar.io/steam/id:gabelogannewell](https://unavatar.io/steam/id:gabelogannewell)
553
-
554
601
  The input supports a URI format `type:value`.
555
602
 
556
603
  When no type is provided, it defaults to `id` (player profile name).
557
604
 
558
- Available URI format inputs:
605
+ Available inputs:
559
606
 
560
607
  - `id` (default): [unavatar.io/steam/id:gabelogannewell](https://unavatar.io/steam/id:gabelogannewell)
561
608
  - `profile`: [unavatar.io/steam/profile:76561198044605749](https://unavatar.io/steam/profile:76561198044605749)
@@ -565,69 +612,53 @@ Available URI format inputs:
565
612
 
566
613
  Get any Substack author's profile picture by their publication username.
567
614
 
568
- Available inputs:
569
-
570
- - Publication username, e.g., [unavatar.io/substack/bankless](https://unavatar.io/substack/bankless)
615
+ e.g., [unavatar.io/substack/bankless](https://unavatar.io/substack/bankless)
571
616
 
572
617
  ### Telegram
573
618
 
574
619
  Get any Telegram user's profile picture by their username.
575
620
 
576
- Available inputs:
577
-
578
- - Username, e.g., [unavatar.io/telegram/drsdavidsoft](https://unavatar.io/telegram/drsdavidsoft)
621
+ e.g., [unavatar.io/telegram/drsdavidsoft](https://unavatar.io/telegram/drsdavidsoft)
579
622
 
580
623
  ### Threads
581
624
 
582
625
  Get any Threads user's profile picture by their username.
583
626
 
584
- Available inputs:
585
-
586
- - Username, e.g., [unavatar.io/threads/zuck](https://unavatar.io/threads/zuck)
627
+ e.g., [unavatar.io/threads/zuck](https://unavatar.io/threads/zuck)
587
628
 
588
629
  ### TikTok
589
630
 
590
631
  Get any TikTok user's profile picture by their username. No authentication or API tokens needed — just pass the username.
591
632
 
592
- Available inputs:
593
-
594
- - Username, e.g., [unavatar.io/tiktok/carlosazaustre](https://unavatar.io/tiktok/carlosazaustre)
633
+ e.g., [unavatar.io/tiktok/carlosazaustre](https://unavatar.io/tiktok/carlosazaustre)
595
634
 
596
635
  ### Tumblr
597
636
 
598
637
  Get any Tumblr blog's profile picture by their username.
599
638
 
600
- Available inputs:
601
-
602
- - Username, e.g., [unavatar.io/tumblr/nasa](https://unavatar.io/tumblr/nasa)
639
+ e.g., [unavatar.io/tumblr/nasa](https://unavatar.io/tumblr/nasa)
603
640
 
604
641
  ### Twitch
605
642
 
606
643
  Get any Twitch streamer's profile picture by their username.
607
644
 
608
- Available inputs:
609
-
610
- - Username, e.g., [unavatar.io/twitch/midudev](https://unavatar.io/twitch/midudev)
645
+ e.g., [unavatar.io/twitch/midudev](https://unavatar.io/twitch/midudev)
611
646
 
612
647
  ### Vimeo
613
648
 
614
649
  Get any Vimeo user's profile picture by their username.
615
650
 
616
- Available inputs:
617
-
618
- - Username, e.g., [unavatar.io/vimeo/ladieswithlenses](https://unavatar.io/vimeo/ladieswithlenses)
651
+ e.g., [unavatar.io/vimeo/ladieswithlenses](https://unavatar.io/vimeo/ladieswithlenses)
619
652
 
620
653
  ### WhatsApp
621
654
 
622
655
  Get the profile picture for a WhatsApp channel or chat by ID.
623
656
 
624
- e.g., [unavatar.io/whatsapp/phone:34660021551](https://unavatar.io/whatsapp/phone:34660021551)
625
-
626
657
  The input supports a URI format `type:id`.
627
658
 
628
659
  If no type is provided, the input is treated as a phone number.
629
660
 
630
- Available URI format inputs:
661
+ Available inputs:
631
662
 
632
663
  - `phone`: [unavatar.io/whatsapp/phone:34660021551](https://unavatar.io/whatsapp/phone:34660021551)
633
664
  - `channel`: [unavatar.io/whatsapp/channel:0029VaARuQ7KwqSXh9fiMc0m](https://unavatar.io/whatsapp/channel:0029VaARuQ7KwqSXh9fiMc0m)
@@ -637,24 +668,18 @@ Available URI format inputs:
637
668
 
638
669
  Get any X (formerly Twitter) user's profile picture by their username.
639
670
 
640
- Available inputs:
641
-
642
- - Username, e.g., [unavatar.io/x/elonmusk](https://unavatar.io/x/elonmusk)
671
+ e.g., [unavatar.io/x/elonmusk](https://unavatar.io/x/elonmusk)
643
672
 
644
673
  ### Xbox Gamertag
645
674
 
646
675
  Get any Xbox player's profile picture by their gamertag.
647
676
 
648
- Available inputs:
649
-
650
- - Gamertag, e.g., [unavatar.io/xboxgamertag/GD-BerserkerTTD](https://unavatar.io/xboxgamertag/GD-BerserkerTTD)
677
+ e.g., [unavatar.io/xboxgamertag/GD-BerserkerTTD](https://unavatar.io/xboxgamertag/GD-BerserkerTTD)
651
678
 
652
679
  ### YouTube
653
680
 
654
681
  Get any YouTube channel's thumbnail by their handle, legacy username, or channel ID.
655
682
 
656
- e.g., [unavatar.io/youtube/casey](https://unavatar.io/youtube/casey)
657
-
658
683
  The endpoint supports specific input formats.
659
684
 
660
685
  If the input starts with `UC` and has 24 characters, it is treated as a channel ID. Otherwise, it is treated as a handle.
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.25.3",
5
+ "version": "3.25.5",
6
6
  "main": "src/index.js",
7
7
  "exports": {
8
8
  ".": "./src/index.js",