Introduction

Get familiar with our free and open source avatar generator API.

From one GET request, an avatar will be returned (in SVG format) with the initials of the name provided. Such a URL is fit to put in an <img> tag with ease. With no rate-limiting or tracking and an excellent up-time record with speedy responses, this tool works great in production, too. If you don't believe us and want to run it for yourself, you can find the ridiculously simple code on GitHub (This page aswell!). Just don't forget to give us credit, eh?


Examples

GET https://avatar.oxro.io/avatar?name=Eddie&background=f39c12&length=1

Returns an SVG avatar with the background color specified in the hex #f39c12 and the intial "E" (specified one)

GET https://avatar.oxro.io/avatar?name=John+Smith&background=#6ab04c&color=000

Returns an SVG avatar with the background color specified in the hex #f39c12 and the intials "JS"

GET https://avatar.oxro.io/avatar?name=Eddie&background=ff6b6b&caps=3&bold=true

Returns an SVG avatar with a random background color and the intials "Ed" (respective capitalization) in the bold version of the font.

Example within img tag: <img src="https://avatar.oxro.io/avatar?name=Eddie">


Parameters

Query Explaination Default
name The name/username/email of the entity you want the avatar's initials to represent O
length How many initials should be present in the avatar? (either 1 or 2) 2
background The background color of the avatar (without the # in a hex) e.g #fff becomes fff Random
color The text color of the avatar (without the # in a hex) e.g #fff becomes fff fff
bold Should the bold version of the font be utilized? false
fontSize The font size for the initials in pixels. 250
height The height of the avatar in pixels 500
width The width of the avatar in pixels 500
caps Capitalization of the letter(s). 3 for leaving such as provided, 2 for all lowercase or 1 for all uppercase. 1

Developed by Edward Jibson and Contributors.