API

Hledejte ikony programaticky. Všechny endpointy vracejí JSON. Není vyžadována autentizace.

Ikony

GET /api/icons/search

Hledá ikony podle názvu napříč všemi sadami ikon. Podporuje fulltextové vyhledávání, trigramovou podobnost a párování synonym.

Parametry

q — Vyhledávací dotaz (povinné)

set — Filtrovat podle kódu sady ikon, např. fluentui, material, phosphor, tabler, lucide, solar (lze opakovat) — všechny kódy viz /api/icon-sets

size — Filtrovat podle velikosti, např. 16, 20, 24, 28, 32, 48 (většina sad je škálovatelná)

style — Filtrovat podle stylu: outline, filled, thin, light, regular, bold, rounded, sharp, duotone, line-duotone, broken, color, brands (liší se podle sady)

limit — Maximální počet výsledků (výchozí: 50, max: 100)

format — Formát odpovědi: json (výchozí), compact, text

Vyzkoušejte: /api/icons/search?q=calendar&set=fluentui&size=24

GET /api/icons/:id

Získá jednu ikonu podle ID. Vrací kompletní metadata včetně názvů souborů, identifikátorů pro platformy, kategorií, frází a SVG URL pro všechny velikosti.

Vyzkoušejte: /api/icons/5403

Sady ikon

GET /api/icon-sets

Vypíše všechny dostupné sady ikon s metadaty: styly, velikosti, licence, metody obarvení, počet ikon a navíc popis a poznámky každé sady (např. zda jsou její poskytovaná SVG normalizována z upstreamu).

Vyzkoušejte: /api/icon-sets

Formáty odpovědí

Parametr format na /api/icons/search řídí podobu odpovědi:

json — Kompletní odpověď: id, icon_set, name, style, style_color_method, sizes, identifikátory ios/android, svg_url

compact — Minimální JSON: icon_set, name, style, url

text — Prostý text, jedna ikona na řádek (nejúspornější na tokeny pro AI)

Pole odpovědi

Klíčová pole v JSON odpovědi:

style_color_method — Jak nastavit barvu ikony přes CSS: "fill", "stroke", nebo "multicolor" (nelze přebarvit)

svg_url — Relativní URL k SVG souboru (např. /icons/fluentui/regular/ic_fluent_calendar_24_regular.svg)

ios — Identifikátor iOS/Swift pro každou velikost (např. {"24": "calendar24Solid"})

android — Identifikátor Android/Kotlin pro každou velikost (např. {"24": "ic_heroicons_calendar_24_solid"})

Další endpointy

GET /api/health

Kontrola stavu. Vrací počet ikon a stav.

Vyzkoušejte: /api/health

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

Poskytne SVG soubor ikony. Cachováno na 1 rok s hlavičkou immutable.

Vyzkoušejte: /icons/fluentui/regular/ic_fluent_calendar_24_regular.svg

Odpověď: image/svg+xml

GET /api/mcp/version

Kontrakt verze MCP klienta: podporované verze latest a min_supported MCP serveru, plus volitelná zpráva a URL changelogu. MCP server toto zkontroluje při spuštění, aby upozornil na dostupnou aktualizaci. Tento endpoint zůstává zpětně kompatibilní, aby signál přežil změny jinde.

Vyzkoušejte: /api/mcp/version

POST /api/maintenance/:task

Spustí úlohu údržby. Vyžaduje hlavičku X-API-Key. Omezeno na 5 požadavků za 5 minut.

Použijte POST /api/maintenance/sync/:icon_set k synchronizaci konkrétní sady (např. fontawesome, fluentui).

Parametry

task — Úloha ke spuštění: sync, clean, cube

X-API-Key — API klíč (hlavička, povinné)

Každá odpověď také nese aktuální kontrakt verze MCP v hlavičkách, takže se klienti dozvědí o aktualizacích i z chybové odpovědi:

X-MCP-Latest — Nejnovější publikovaná verze MCP.

X-MCP-Min-Supported — Nejstarší stále přijímaná verze MCP; pod touto hranicí by měl klient aktualizovat.

Integrace s AI / LLM

Pro AI asistenty a LLM použijte textový formát pro maximální efektivitu tokenů. Nabízíme také MCP server pro přímou integraci s Claude Desktop a Claude Code.

MCP server (Claude Desktop / Claude Code)

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

Endpoint vhodný pro LLM

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

Strojově čitelná dokumentace

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

Příklady použití

Hledat ikony

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

Filtrovat podle více sad ikon

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

Získat detail ikony

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

Výpis sad ikon

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}`));

Spustit synchronizaci (autentizované)

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