API

Symbole programmatisch suchen. Alle Endpunkte geben JSON zurück. Keine Authentifizierung erforderlich.

Symbole

GET /api/icons/search

Symbole nach Namen über alle Symbolsets hinweg suchen. Unterstützt Volltextsuche, Trigramm-Ähnlichkeit und Synonym-Abgleich.

Parameter

q — Suchanfrage (erforderlich)

set — Nach Symbolset-Code filtern, z. B. fluentui, material, phosphor, tabler, lucide, solar (wiederholbar) — alle Codes siehe /api/icon-sets

size — Nach Größe filtern, z. B. 16, 20, 24, 28, 32, 48 (die meisten Sets sind skalierbar)

style — Nach Stil filtern: outline, filled, thin, light, regular, bold, rounded, sharp, duotone, line-duotone, broken, color, brands (je nach Set unterschiedlich)

limit — Maximale Anzahl an Ergebnissen (Standard: 50, max: 100)

format — Antwortformat: json (Standard), compact, text

Ausprobieren: /api/icons/search?q=calendar&set=fluentui&size=24

GET /api/icons/:id

Ruft ein einzelnes Symbol anhand der ID ab. Gibt die vollständigen Metadaten zurück, einschließlich Dateinamen, Plattform-Bezeichnern, Kategorien, Phrasen und SVG-URLs für alle Größen.

Ausprobieren: /api/icons/5403

Symbolsets

GET /api/icon-sets

Alle verfügbaren Symbolsets mit Metadaten auflisten: Stile, Größen, Lizenz, Farbmethoden, Anzahl der Symbole sowie die Beschreibung und Hinweise jedes Sets (z. B. ob die ausgelieferten SVGs gegenüber der Quelle normalisiert wurden).

Ausprobieren: /api/icon-sets

Antwortformate

Der Parameter format auf /api/icons/search steuert die Form der Antwort:

json — Vollständige Antwort: id, icon_set, name, style, style_color_method, sizes, ios/android-Bezeichner, svg_url

compact — Minimales JSON: icon_set, name, style, url

text — Reiner Text, ein Symbol pro Zeile (am token-effizientesten für KI)

Antwortfelder

Wichtige Felder in der JSON-Antwort:

style_color_method — So legen Sie die Symbolfarbe per CSS fest: "fill", "stroke" oder "multicolor" (nicht umfärbbar)

svg_url — Relative URL zur SVG-Datei (z. B. /icons/fluentui/regular/ic_fluent_calendar_24_regular.svg)

ios — iOS-/Swift-Bezeichner je Größe (z. B. {"24": "calendar24Solid"})

android — Android-/Kotlin-Bezeichner je Größe (z. B. {"24": "ic_heroicons_calendar_24_solid"})

Weitere Endpunkte

GET /api/health

Statusprüfung. Gibt die Anzahl der Symbole und den Status zurück.

Ausprobieren: /api/health

GET /icons/:icon_set/:style/:filename

Liefert eine SVG-Symboldatei aus. 1 Jahr lang zwischengespeichert mit immutable-Header.

Ausprobieren: /icons/fluentui/regular/ic_fluent_calendar_24_regular.svg

Antwort: image/svg+xml

GET /api/mcp/version

Versionsvertrag des MCP-Clients: die akzeptierten Versionen latest und min_supported des MCP-Servers, plus optionale Nachricht und Changelog-URL. Der MCP-Server prüft dies beim Start, um auf verfügbare Aktualisierungen hinzuweisen. Dieser Endpunkt bleibt abwärtskompatibel, damit das Signal Änderungen an anderer Stelle übersteht.

Ausprobieren: /api/mcp/version

POST /api/maintenance/:task

Löst eine Wartungsaufgabe aus. Erfordert den Header X-API-Key. Begrenzt auf 5 Anfragen pro 5 Minuten.

Verwenden Sie POST /api/maintenance/sync/:icon_set, um ein bestimmtes Set zu synchronisieren (z. B. fontawesome, fluentui).

Parameter

task — Auszuführende Aufgabe: sync, clean, cube

X-API-Key — API-Schlüssel (Header, erforderlich)

Jede Antwort trägt außerdem den aktuellen MCP-Versionsvertrag als Header, sodass Clients auch aus einer Fehlerantwort von Aktualisierungen erfahren:

X-MCP-Latest — Neueste veröffentlichte MCP-Version.

X-MCP-Min-Supported — Älteste noch akzeptierte MCP-Version; darunter sollte ein Client aktualisieren.

KI-/LLM-Integration

Für KI-Assistenten und LLMs sollten Sie das Textformat für maximale Token-Effizienz verwenden. Wir stellen außerdem einen MCP-Server für die direkte Integration mit Claude Desktop und Claude Code bereit.

MCP-Server (Claude Desktop / Claude Code)

{
  "mcpServers": {
    "pure-admin-icons": {
      "command": "npx",
      "args": ["-y", "-p", "@keenmate/pure-admin-icons-mcp", "pure-admin-icons-mcp"]
    }
  }
}

LLM-freundlicher Endpunkt

curl 'https://icons.pureadmin.io/api/icons/search?q=calendar&format=text'

Maschinenlesbare Dokumentation

/llms.txt · /.well-known/ai-plugin.json

Anwendungsbeispiele

Symbole suchen

curl 'https://icons.pureadmin.io/api/icons/search?q=pen&size=24&limit=5'

Nach mehreren Symbolsets filtern

curl 'https://icons.pureadmin.io/api/icons/search?q=arrow&set=heroicons&set=lucide&set=fontawesome'

Symboldetails abrufen

curl 'https://icons.pureadmin.io/api/icons/5403'

Symbolsets auflisten

curl 'https://icons.pureadmin.io/api/icon-sets'

JavaScript

const res = await fetch('https://icons.pureadmin.io/api/icons/search?q=calendar&format=compact');
const { results } = await res.json();
console.log(results.map(i => `${i.icon_set}/${i.name}`));

Synchronisation auslösen (authentifiziert)

curl -X POST -H "X-API-Key: your-key" 'https://icons.pureadmin.io/api/maintenance/sync/fontawesome'