API Guidelines

To save time and increase your chances of having your application approved, ensure your application meets the guidelines.

If your submission does not clearly meet all of the guidelines, it will likely be rejected until you provide clear examples of all of the guidelines being met.

Technical Guidelines

Icon source

Files (JSON & SVG Pack) are provided through temporary download links. These files can be cached and hosted on your servers. Due to their temporary nature, these links are not intended for direct use by end users.

View documentation for more information

Library panel

The panel allowing your end users to select icons should display the Lordicon name or logo, e.g., "Lordicon." Users should be able to preview the animation and customize the selected icon directly from the library panel.

Search

The search engine within the Library panel should be optimized to utilize all available data, including icon names, tags, categories, and descriptions.

Customization

The end user should be able to customize icons based on specific features, such as colors, stroke, and animation.

Triggers

To ensure the best appearance of the icons, each animation type should be properly paired with its corresponding animation trigger. Learn more.

Tracking Downloads

You must implement Tracking Downloads when distributing icons, ensuring that each used icon triggers an event. Reporting is required when an icon is embedded, duplicated, or modified within a project. However, previewing, displaying already reported icons, or making changes without final use does not require reporting.

Actions that require reporting of download:
  • The application processes the icon and continues to serve it as part of its functionality.
  • A user of your application decides to embed the selected icon in a document, project, or artboard.
  • A user of your application embeds the previously embedded icon, but e.g. with a different color scheme or animation type, into a document, project, or artboard.
  • A user of your application reused the same icon in the same project, even if its use had already been reported. For example, the user duplicates a previously added icon in the same document, project, or artboard or decides to move it to another document, project, or artboard (copy/paste functions).
Actions that do not require reporting of download:
  • A user of your application previews a list of icons in the application interface to make a specific selection.
  • A user of your application or their guests invited to a document, project, or artboard display an already reported icon in that document, project, or artboard.
  • A user of your application selects an icon or changes its color or animation but ultimately does not use it in the project.

Attribution

This only applies to Lordicon API FREE users. When displaying an icon from Lordicon, your application must attribute Lordicon and contain a link back to Lordicon (doesn't apply to rendered videos or static images that don't carry URL redirects).

All links back to Lordicon should use UTM parameters:

https://lordicon.com/icons/?utm_source=your_app_name&utm_medium=referral

Security

Your application's token must be kept confidential. For enhanced security, we recommend enabling two-factor authentication (2FA) and using a proxy server when accessing the API from the client-side.

Usage Guidelines

  • You cannot use the Lordicon name directly in your application name and you cannot use the Lordicon logo as your application icon.

  • You cannot replicate the core user experience of Lordicon (library, plugins, etc.).

  • The API is to be used for non-automated, high-quality, and authentic experiences.

  • Do not abuse the APIs. Too many requests too quickly will get your access turned off.

  • Applications should not require users to register for a developer account with the Lordicon API to use your application.

We suggest checking out the accompanying articles, which feature visual and code examples. If you have any questions afterward, feel free to contact us.