Skip to main content

​
Overview

MZR Icons provides a set of stateless API endpoints that return SVG images. These images are generated on-the-fly based on the query parameters you provide. The base URL for all API requests is: https://icon.mzrdev.com/

​
Authentication

MZR Icons is completely open and free to use. There is no authentication or API keys required for any of our standard endpoints.

​
Content Type

All successful API requests will return a response with the following header: Content-Type: image/svg+xml; charset=utf-8

​
Caching

To ensure high performance and reduce load on GitHub’s API, we implement aggressive caching:
  • Standard components are cached for 24 hours.
  • Social stats (Followers/Views) are cached for 1 hour.

​
Error Handling

If a request fails (e.g., a username is not found), the API will return a non-200 status code with a plain text error message.