Avataaars

Designed by Pablo Stanley. The Sketch library can be found on avataaars.com.

Usage

HTTP-API (recommended)

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

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

See the HTTP API documentation for more information.

NPM

Install the Avatars and this avatar style with the following command.

npm install --save @dicebear/avatars @dicebear/avatars-avataaars-sprites

Now you are ready to create your first Avatar.

import { createAvatar } from '@dicebear/avatars';

import * as style from '@dicebear/avatars-avataaars-sprites';

let svg = createAvatar(style, {

seed: 'custom-seed',

// ... and other options

});

Options

Base options

seed Seed Alias: s Default: undefined Type: string

dataUri Data URI Default: false Type: boolean

radius Radius Alias: r Default: 0 Type: integer Minimum: 0 Maximum: 50

width Width Alias: w Default: undefined Type: integer Minimum: 1

height Height Alias: h Default: undefined Type: integer Minimum: 1

margin Margin Alias: m Default: 0 Type: integer Minimum: 0 Maximum: 25

backgroundColor Background Color Alias: b Default: transparent Type: string Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})+$ or Type: string Enum: transparent

Style options

style Style Default: undefined Type: string Enum: transparent, circle

top Top Default: undefined Type: array Items: Type: string Enum: longHair, shortHair, eyepatch, hat, hijab, turban, bigHair, bob, bun, curly, curvy, dreads, frida, fro, froAndBand, miaWallace, longButNotTooLong, shavedSides, straight01, straight02, straightAndStrand, dreads01, dreads02, frizzle, shaggy, shaggyMullet, shortCurly, shortFlat, shortRound, shortWaved, sides, theCaesar, theCaesarAndSidePart, winterHat01, winterHat02, winterHat03, winterHat04

topChance Top Probability Default: undefined Type: integer Minimum: 0 Maximum: 100

hatColor Hat Color Default: undefined Type: array Items: Type: string Enum: black, blue, blue01, blue02, blue03, gray, gray01, gray02, heather, pastel, pastelBlue, pastelGreen, pastelOrange, pastelRed, pastelYellow, pink, red, white

hairColor Hair Color Default: undefined Type: array Items: Type: string Enum: auburn, black, blonde, blondeGolden, brown, brownDark, pastel, pastelPink, platinum, red, gray, silverGray

accessories Accessories Default: undefined Type: array Items: Type: string Enum: kurt, prescription01, prescription02, round, sunglasses, wayfarers

accessoriesChance Accessories Probability Default: undefined Type: integer Minimum: 0 Maximum: 100

accessoriesColor Accessories Color Default: undefined Type: array Items: Type: string Enum: black, blue, blue01, blue02, blue03, gray, gray01, gray02, heather, pastel, pastelBlue, pastelGreen, pastelOrange, pastelRed, pastelYellow, pink, red, white

facialHair Facial Hair Default: undefined Type: array Items: Type: string Enum: medium, beardMedium, light, beardLight, majestic, beardMajestic, fancy, moustaceFancy, magnum, moustacheMagnum

facialHairChance Facial Hair Probability Default: undefined Type: integer Minimum: 0 Maximum: 100

facialHairColor Facial Hair Color Default: undefined Type: array Items: Type: string Enum: auburn, black, blonde, blondeGolden, brown, brownDark, pastel, pastelPink, platinum, red, gray, silverGray

clothes Clothes Default: undefined Type: array Items: Type: string Enum: blazer, blazerAndShirt, blazerAndSweater, sweater, collarAndSweater, shirt, graphicShirt, shirtCrewNeck, shirtScoopNeck, shirtVNeck, hoodie, overall

clothesColor Clothes Color Default: undefined Type: array Items: Type: string Enum: black, blue, blue01, blue02, blue03, gray, gray01, gray02, heather, pastel, pastelBlue, pastelGreen, pastelOrange, pastelRed, pastelYellow, pink, red, white

eyes Eyes Default: undefined Type: array Items: Type: string Enum: close, closed, cry, default, dizzy, xDizzy, roll, eyeRoll, happy, hearts, side, squint, surprised, wink, winkWacky

eyebrow Eyebrow Default: undefined Type: array Items: Type: string Enum: angry, angryNatural, default, defaultNatural, flat, flatNatural, raised, raisedExcited, raisedExcitedNatural, sad, sadConcerned, sadConcernedNatural, unibrow, unibrowNatural, up, upDown, upDownNatural, frown, frownNatural

mouth Mouth Default: undefined Type: array Items: Type: string Enum: concerned, default, disbelief, eating, grimace, sad, scream, screamOpen, serious, smile, tongue, twinkle, vomit

skin Skin Default: undefined Type: array Items: Type: string Enum: tanned, yellow, pale, light, brown, darkBrown, black

clotheGraphics Clothe Graphics Default: undefined Type: array Items: Type: string Enum: skullOutline, skull, resist, pizza, hola, diamond, deer, cumbia, bear, bat