All requests returns a image stream to be used directly in a <img/>
tag.
https://avatar.bitwize.ae/api/?name=John+Doe
https://avatar.bitwize.ae/api/?background=0D8ABC&color=fff
Avoid passing color as it will be automatically set between black and white.
https://avatar.bitwize.ae/api/?background=random
size
)Avatar image size in pixels. Between: 16 and 512. Default: 64
https://avatar.bitwize.ae/api/?size=128
font-size
)Font size in percentage of size
. Between 0.1 and 1. Default: 0.5
https://avatar.bitwize.ae/api/?font-size=0.33
length
)Length of the generated initials. Default: 2
https://avatar.bitwize.ae/api/?length=1
name
)The name used to generate initials. You can specify the initials yourself as well. Default: John Doe
https://avatar.bitwize.ae/api/?name=Elon+Musk
rounded
)Boolean specifying if the returned image should be a circle. Default: false
https://avatar.bitwize.ae/api/?rounded=true
bold
)Boolean specifying if the returned letters should use a bold font. Default: false
https://avatar.bitwize.ae/api/?bold=true
background
)Hex color for the image background, without the hash (#). Default: ddd
https://avatar.bitwize.ae/api/?background=a0a0a0
color
)Hex color for the font, without the hash (#). Default: 222
https://avatar.bitwize.ae/api/?color=ff0000
uppercase
)Decide if the API should uppercase the name/initials. Default: true
https://avatar.bitwize.ae/api/?uppercase=false&name=different+Case
format
)Decide if the API should return SVG or PNG. Default: svg if the Accept
header includes image/svg+xml
, png otherwise
https://avatar.bitwize.ae/api/?format=svg
All settings above can be mixed together as you desire.
A good use-case would be using it as a fallback for Gravatar. Example:
https://www.gravatar.com/avatar/EMAIL_MD5?d=https%3A%2F%2Favatar.bitwize.ae%2Fapi%2F/Lasse+Rafn/128
Because of limitations in Gravatar, we must pass in the parameters as sub-directories, instead of query-parameters. You should also consider urlencoding the name, in case it contains special characters. It's a limitation by Gravatar, not UI Avatars.
The order is as follows:I recommend using 1.5x or 2x sizes for your avatars, but keeping the img tag the original size, to ensure crisp avatars on high DPI screens.
I have added support for some unicode scripts/languages that are not supported by the typical fonts. Current support: