Skip to content

Iconify API ​

Iconify API is an open source hosted (or self-hosted) service for developers.

What is it for?

  • API provides icon data, which made it possible to create Iconify icon components that load icons demand.
  • API generates SVG, which developers can link to in HTML or stylesheet.
  • API generates CSS to render icons as background or mask images.
  • API has a search engine for hosted icons, which can be used by icon pickers. Currently used by Iconify plug-ins for various UI design tools.

API can be used to offer hundreds of thousands of icons in website builders or theme customisers. Host your own API, use API's search engine in custom icon picker to allow users select icons, use icon components in UI to render icons.

Hosting API ​

You can host your own Iconify API service.

By hosting Iconify API yourself you:

  • Have full control over servers instead of relying on third party service.
  • Can choose which icon sets to host or host your own icon sets.

See hosting Iconify API for more details.

API is available on:

  • GitHub - you can customise it before deploying.
  • NPM - can be embedded in an app without running a full server.
  • Docker - for quick deployment.

Public API ​

Iconify project offers public API servers, which host over 300k icons from more than 200 open source icon sets.

To improve loading times, API is hosted on multiple servers in different parts of the world. Icons are usually loaded within fraction of a second.

Public API is available at https://api.iconify.design.

It is a public service, servers are free to use, but please do keep in mind that running those servers is not free. If you are using public API or API software, please consider supporting Iconify to help out with infrastructure, development and maintenance costs.

Limits ​

Public API has limits to prevent abuse and ensure fair usage.

Its main use case is for Iconify icon components to load icons on demand. Any other use is a bonus that should not be abused.

If you want API without limits, you can host your own Iconify API.

Queries ​

Iconify API can be used to render SVG, to retrieve icon data, to browse and search icons.

For full list of supported queries, their parameters and API responses see Iconify API queries documentation.

API providers ​

Iconify icon components can retrieve icons from multiple API servers.

This allows you to run your own API to serve only custom icons, while using public Iconify API to get data for open source icon sets.

See Iconify API providers for details.