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 sprite collection. Just use the following URL as image source.
https://avatars.dicebear.com/api/avataaars/:seed.svg
The value of :seed can be anything you like - but don't use any sensitive or personal data here! The GET parameter
options can be used to pass options.
Examples
NPM
Install the Avatars and this sprite collection with the following command.
npm install --save @dicebear/avatars @dicebear/avatars-avataaars-sprites
Now you are ready to create your first Avatar.
;; let options = {};let avatars = sprites options;let svg = avatars;Options
| name | alias | type | default | description |
|---|---|---|---|---|
| radius | r | number | 0 |
Avatar border radius |
| base64 | bool | false |
Return avatar as base64 data uri instead of XML Not supported by the HTTP API |
|
| width | w | number | null |
Fixed width |
| height | h | number | null |
Fixed height |
| margin | m | number | 0 |
Avatar margin in percent HTTP-API limitation Max value 25 |
| background | b | string | null |
Any valid color identifier HTTP-API limitation Only hex (3-digit, 6-digit and 8-digit) values are allowed. Use url encoded hash: %23. |
| userAgent | string | window.navigator.userAgent |
User-Agent for legacy browser fallback Automatically detected by the HTTP API |
|
| style | string | transparent |
One of: transparent, circle |
|
| mode | string | include |
include or exclude passed options. |
|
| top | array of strings | null |
Possible values: longHair, shortHair, eyepatch, hat, hijab, turban |
|
| topChance | number | 100 |
Probability in percent | |
| hatColor | array of strings | null |
Possible values: black, blue, gray, heather, pastel, pink, red, white |
|
| hairColor | array of strings | null |
Possible values: auburn, black, blonde, brown, pastel, platinum, red, gray |
|
| accessories | array of strings | null |
Possible values: kurt, prescription01, prescription02, round, sunglasses, wayfarers |
|
| accessoriesChance | number | 10 |
Probability in percent | |
| facialHair | array of strings | null |
Possible values: medium, light, majestic, fancy, magnum |
|
| facialHairChance | number | 10 |
Probability in percent | |
| facialHairColor | array of strings | null |
Possible values: auburn, black, blonde, brown, platinum, red |
|
| clothes | array of strings | null |
Possible values: blazer, sweater, shirt, hoodie, overall |
|
| clothesColor | array of strings | null |
Possible values: black, blue, gray, heather, pastel, pink, red, white |
|
| eyes | array of strings | null |
Possible values: close, cry, default, dizzy, roll, happy, hearts, side, squint, surprised, wink, winkWacky |
|
| eyebrow | array of strings | null |
Possible values: angry, default, flat, raised, sad, unibrow, up |
|
| mouth | array of strings | null |
Possible values: concerned, default, disbelief, eating, grimace, sad, scream, serious, smile, tongue, twinkle, vomit |
|
| skin | array of strings | null |
Possible values: tanned, yellow, pale, light, brown, darkBrown, black |
Further information
You can find the DiceBear Avatars documentation at avatars.dicebear.com
![https://avatars.dicebear.com/api/avataaars/example.svg?options[top][]=shortHair](https://avatars.dicebear.com/api/avataaars/example.svg?options%5Btop%5D%5B%5D=shortHair){kind=link}
![https://avatars.dicebear.com/api/avataaars/example.svg?options[top][]=shortHair&options[accessoriesChance]=93](https://avatars.dicebear.com/api/avataaars/example.svg?options%5Btop%5D%5B%5D=shortHair&options%5BaccessoriesChance%5D=93){kind=link}