API Documentation

To use our API, you first need to create an account on the Lordicon platform. After registering and logging in, you can start creating projects using the API.

Creating a Project

Once logged into your account, navigate to the API section and click on "Register new project". Follow the form instructions to enter a title and description for your project. Your project will be created, and you will gain access to its demo version.

Demo Project

The demo project is a fully functional version of your application, allowing you to test its functionality before deployment to production. As part of the demo version, you will receive an authentication token for secure communication with the Lordicon server via our API. The demo project provides access to a limited portion of our icon collection.

Project Verification

You can submit your created project for verification. This process allows you to upgrade its plan from demo to free or pro. Verified plans enable a higher number of requests to the server, with the pro plan granting full access to premium resources.

Each request to the Lordicon API must include an Authorization header with an authentication token, which you receive upon creating your application. The token ensures the security and authorization of requests.

Example of using the token in the request header:

Requests to the server are subject to limits. You can check how many requests are remaining and when the counter will reset by using the following response headers:

• X-RateLimit-Limit - the maximum number of requests that can be made within a specific time window.
• X-RateLimit-Remaining - the number of remaining requests that can be made in the current time window.
• X-RateLimit-Reset - the time (in seconds) until the request counter resets.

Exceeding these limits will result in the server returning HTTP error code 429.

For some queries, the returned dataset may be too large to process in a single request. In such cases, we provide a pagination mechanism that allows accessing all data by making multiple consecutive requests.

Headers returned in this context:

• X-Page - The current page number of records.
• X-Per-Page - The number of records returned per page.
• X-Total-Count - The total number of available records for the query.
• Link - This header contains paths to additional results.

Example value of the Link header:

Below is a list of methods you can use to communicate with our API.

This method lets you retrieve a list of available icon families and their styles. It helps you understand which icon sets are available and what filtering options you can use. The response also includes the number of free and premium icons for each style.

Example Request:

Example Response:

This method returns a collection of available icons that meet specified criteria. It allows for searching and filtering icons based on various parameters.

Example Request:

Example Response:

The links (files) provided in the response are primarily for previewing and downloading (processing) by your project. These links have a limited lifespan, so if you want a resource to be available later, you must download it and host it on your own server.

The response may include three types of links: "preview", "svg", and "json". Access to "svg" and "json" links is only available if the icon is included in your plan. For example, users of free applications will only receive a "preview" link for premium resources, allowing them to preview the entire library of icons before deciding to upgrade to a pro plan.

Available Parameters:

• search - allows searching within the collection for a specific phrase.
• family - filters by icon family.
• style - filters by icon style.
• premium - filters by the type of icons.
• index - filters by icon index.
• page - specifies the page of results.
• per_page - specifies the number of results per page (up to 100).

This method is used to inform the server about a user downloading a specific icon. We expect that an application utilizing our API will report each resource download by the user when embedded on a website, presentation, or any other medium using our API. Downloads for previewing and adjusting icons before embedding do not require reporting.

Accurate reporting of downloads enables us to properly account for your API usage and associated costs. Downloads of free icons are not considered in the billing for the pro plan.

Example Request:

Example Response:

This method allows you to retrieve statistics regarding downloaded icons for a given project, including the number of downloads for free and premium icons on a specific day. The returned data may be cached, which means the statistics are not updated in real-time.

You can use this data to limit access to premium icons for your users if you find they are using them excessively within a billing period.

Example Request:

Example Response:

Available Parameters:

• page - specifies the page of results.
• per_page - specifies the number of results per page (maximum 100).