Usage

All requests returns a image stream to be used directly in a <img/> tag.

Generate a avatar with default settings, for user "John Doe".

https://api.proxeuse.com/avatars/api/?name=John+Doe

Generate a blue avatar

https://api.proxeuse.com/avatars/api/?background=0D8ABC&color=fff

Settings

Image Size (size)

Avatar image size in pixels. Between: 16 and 512. Default: 64

https://api.proxeuse.com/avatars/api/?size=128

Font Size (font-size)

Font size in percentage of size. Between 0.1 and 1. Default: 0.5

https://api.proxeuse.com/avatars/api/?font-size=0.33

Initial Characters (length)

Length of the generated initials. Default: 2

https://api.proxeuse.com/avatars/api/?length=1

Name (name)

The name used to generate initials. You can specify the initials yourself as well. Default: John Doe

https://api.proxeuse.com/avatars/api/?name=Elon+Musk

Rounded Image (rounded)

Boolean specifying if the returned image should be a circle. Default: false

https://api.proxeuse.com/avatars/api/?rounded=true

Bold (bold)

Boolean specifying if the returned letters should use a bold font. Default: false

https://api.proxeuse.com/avatars/api/?bold=true

Background Color (background)

Hex color for the image background, without the hash (#). Default: ddd

https://api.proxeuse.com/avatars/api/?background=a0a0a0

Font Color (color)

Hex color for the font, without the hash (#). Default: 222

https://api.proxeuse.com/avatars/api/?color=ff0000

Uppercase (uppercase)

Decide if the API should uppercase the name/initials. Default: true

https://api.proxeuse.com/avatars/api/?uppercase=false&name=different+Case

Format (format)

Decide if the API should return SVG or PNG. Default: svg if the Accept header includes image/svg+xml, png otherwise

https://api.proxeuse.com/avatars/api/?format=svg

All settings above can be mixed together as you desire.

Retina

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.

Language/Script support

I have added support for some unicode scripts/languages that are not supported by the typical fonts. Current support:

• Arabic
• Armenian
• Bengali
• Georgian
• Hebrew
• Chinese
• Japanese
• Mongolian
• Thai
• Tibetan

Privacy and Monitoring

Only access logs are stored, these only contain IP addresses and Browser Agents. This data is automatically deleted after 31 days.

---