REST API

Schreibgeschützte JSON-API für Icons und Kategorien. Basis-URL: https://iconfold.com/api

Authentifizierung

Jede Anfrage braucht einen API-Schlüssel. Erstelle einen auf deiner Profilseite und sende ihn im Header X-API-Key. Authorization: Bearer … funktioniert ebenfalls.

curl -H "X-API-Key: iv_your_key_here" "https://iconfold.com/api/icons?per_page=5"

Ratenlimits

Jeder Schlüssel kann 1,000 Anfragen pro Stunde stellen. Anonyme Anfragen teilen sich ein niedrigeres Limit pro IP-Adresse. Jede Antwort enthält X-RateLimit-Limit; bei Überschreitung kommt HTTP 429.

Antwortformat

Antworten sind JSON mit einem Feld data und bei Listen einem Feld meta mit der Seitennavigation.

{
  "data": [
    {
      "id": 109,
      "name": "Home",
      "slug": "fingerprint",
      "category": "UI & UX",
      "style": "outline",
      "license": "Free for commercial use",
      "premium": false,
      "downloads": 1204,
      "svg_url": "https://iconfold.com/svg/fingerprint.svg",
      "url": "https://iconfold.com/de/icon/fingerprint"
    }
  ],
  "meta": { "page": 1, "per_page": 24, "total": 173, "total_pages": 8 }
}

GET /icons

Listet veröffentlichte Icons auf. Unterstützt dieselben Filter wie die Website.

ParameterBeschreibung
pageSeitennummer, Standard 1
per_page1 bis 100, Standard 24
categoryKategorie-Slug
tagTag-Slug
styleoutline, bold, duotone, color…
colormonochrome, multicolor, red, blue…
licensefree oder premium
sortpopular, newest, downloads, az
include_svg1, um SVG-Code in jedes Element einzubetten (nur kostenlose Icons)
GET https://iconfold.com/api/icons?category=weather&per_page=2

GET /icons/{id or slug}

Ein Icon mit Tags, Lizenz und SVG-Code (kostenlose Icons oder Premium-Icons, die deinem Konto gehören).

GET https://iconfold.com/api/icons/fingerprint

GET /categories

Alle Kategorien mit Icon-Anzahl.

GET https://iconfold.com/api/categories

GET /search?q=

Volltextsuche in Namen, Tags, Stichwörtern und Kategorien. Akzeptiert auch die Filter von /icons.

ParameterBeschreibung
qSuchbegriff, erforderlich
GET https://iconfold.com/api/search?q=arrow

Fehler

Fehler verwenden normale HTTP-Statuscodes mit einem Body wie {"error": {"code": 401, "message": "…"}}: 401 bei fehlendem oder ungültigem Schlüssel, 403 bei Premium-Inhalten, die dir nicht gehören, 404 wenn nichts passt und 429 bei überschrittenem Limit.