HTTP-API
Our HTTP API is probably the easiest way to use DiceBear. Thanks to our sponsor bunny.net it is lightning fast worldwide. You can use our official instance or run your own. Yes, the API is also OpenSource!
Usage
Use the following address and replace <styleName> with your preferred avatar style (camelCase). Every official avatar style is supported.
https://api.dicebear.com/5.x/<styleName>/svg
A few examples
INFO
We provide a large number of avatar styles from different designers. The designs are licensed under different licenses that the designers can choose themselves. Some licenses require attribution. For a quick overview we have created an license overview for you.
Options
Options can be passed via the query string. For example, you can set a seed like this:
TIP
If you want to pass more options, you connect them with a & as usual with query strings.
Array options
Array values are separated by a comma. For example, the URL could look like this if you want to provide the PRNG with several hair styles in addition to the seed. Note that the avatar styles provide different options. In this example, we use the Pixel Art avatar style.
Boolean options
Boolean values can be set as strings (true and false).
File format
The API supports SVG, PNG, JPG and JSON. We recommend using SVG if possible! SVG is the more modern format, scales indefinitely, and requires less traffic. Because the PNG and JPG formats put more load on the API, the size is limited to 256x256.
Versioning
You can set the version in the URL to be guaranteed to have an identical avatar even after updates. Just replace the 5.x from the previous examples with the one you want. Currently supported: 5.x, 5.3, 5.2, 5.1, 5.0, 4.x, 4.10, 4.9, 4.8, 4.7, 4.6, 4.5 and 4.4.
WARNING
The 4.* versions will be discontinued at the end of 2023. You can set up your own instance of the API to still access versions 4.* afterwards.
Fair use
Our API is free to use, but we ask that you use it responsibly. We reserve the right to block abusive users. Currently, we limit the number of requests per second to 50. We also ask you to use the API only for non-commercial purposes. If you want to use the API for commercial purposes or need more requests per second, please set up your own instance.
We are happy to answer any questions you may have. Just open an discussion on GitHub.
Changes and Availability
Please be aware that we reserve the right to update the API at any time. While we will do our best to maintain backwards compatibility, we cannot guarantee this. Additionally, we cannot guarantee that the API will always be available. If you need consistent access to the API, we recommend setting up your own instance.
