Our free HTTP-API is the easiest way to use Avatars. Just use the following URL as image source.

https://avatars.dicebear.com/api/:sprites/:seed.svg

Replace :sprites with male, female, human, identicon, initials, bottts, avataaars, jdenticon, gridy or code. The value of :seed can be anything you like - but don't use any sensitive or personal data here!

The used sprite collection may offer additional options, which can be set using GET parameters. For example, to create a happy male avatar with the seed john, the following URL can be used:

https://avatars.dicebear.com/api/male/john.svg?mood[]=happy

Choose NPM if you want to use a spriteCollection that is not available via the HTTP-API.

Install the Avatars package with the following command.

$ npm install --save @dicebear/avatars

You also need to add a sprite collection. In our example, we will use the male sprite collection.

$ npm install --save @dicebear/avatars-male-sprites

Now you are ready to create your first Avatar.

import Avatars from '@dicebear/avatars';
import sprites from '@dicebear/avatars-male-sprites';

let options = {};
let avatars = new Avatars(sprites, options);
let svg = avatars.create('custom-seed');