ממשק API למפתחים

ממשק קריאה בלבד, ללא מפתח וללא הרשמה, שמחזיר JSON. החיפוש מבין עברית: שאילתה בעברית מומרת למושגים באנגלית, והתשובה מסבירה מה הובן. מזהי האייקונים הם באנגלית (lucide:house). הרישיון של כל אייקון הוא של הסט שלו, ראו רישיונות וייחוסים.

תיאור מכונה לפי OpenAPI 3.1: /openapi.json.

curl "/api/v1/search?q=בית&limit=3"
curl "/api/v1/icon?id=lucide:house&format=svg"

כל כתובת מוגבלת ל-120 בקשות בדקה. כל תשובה כוללת את הכותרות X-RateLimit-Limit, X-RateLimit-Remaining ו-X-RateLimit-Reset. מי שחרג מקבל 429 עם Retry-After בשניות. ההגבלה נספרת בזיכרון של כל מופע של השרת, ולכן היא מנגנון הגנה גס ולא מכסה מדויקת. לצרכים גדולים אפשר לקבל מפתח אופציונלי שמעלה את המכסה (1,200 בדקה): שולחים אותו בכותרת Authorization: Bearer ‏<key> או X-API-Key. לבקשת מפתח כתבו לכתובת שבעמוד הפרטיות.

get /api/v1/search

מחזיר אייקונים לפי שאילתה. שאילתה בעברית מורחבת למושגים באנגלית, ובתשובה מופיע `matchedConcepts` שמסביר מה הובן, ו-`unknownTerms` עם מילים שלא זוהו.

• q (חובה): השאילתה, בעברית או באנגלית.
• collection: הגבלה לסט אחד, למשל `lucide`.
• style: סגנון: `outline`, `solid` או מזהה סגנון מדויק.
• limit: מספר התוצאות המרבי (עד 999, ברירת מחדל 32).
• svg: `1` כדי לכלול את ה-SVG בכל תוצאה.
• prefer: סט מועדף לסידור התוצאות.
• lang: `he` או `auto` מרחיבים שאילתה עברית; `en` מחפש את הטקסט כפי שהוקלד.

תשובות: 200 תוצאות החיפוש. · 400 חסר `q`, או שם סט לא מוכר. · 429 חרגתם ממכסת הבקשות. חכו את מספר השניות שב-`Retry-After`. · 500 שגיאה בשרת.

get /api/v1/icon

מחזיר אייקון כ-JSON, או כקוד מוכן לפי `format`.

• id (חובה): מזהה אייקון בצורה `סט:שם`, למשל `lucide:house`.
• format: `json` (ברירת מחדל) מחזיר אובייקט; שאר הערכים מחזירים טקסט: `svg`, `html`, `react`, `react-native`, `vue`, `svelte`, `solid`, `flutter`, `jsx`.
• color: צבע, למשל `#1e40af`. ברירת המחדל היא `currentColor`.
• variant: מזהה סגנון בתוך הסט.
• size: גודל בפיקסלים.

תשובות: 200 האייקון. הסוג תלוי ב-`format`. · 400 חסר `id`, או `format` לא מוכר. · 404 האייקון לא נמצא. · 429 חרגתם ממכסת הבקשות. חכו את מספר השניות שב-`Retry-After`. · 500 שגיאה בשרת.

get /api/v1/icons

עד 20 מזהים. אפשר גם בגוף בקשה (POST) כשהרשימה ארוכה.

• ids (חובה): מזהים מופרדים בפסיקים.
• color
• size

תשובות: 200 האייקונים שנמצאו, ושגיאות לכל מזהה שלא נמצא. · 400 לא נשלחו מזהים. · 429 חרגתם ממכסת הבקשות. חכו את מספר השניות שב-`Retry-After`. · 500 שגיאה בשרת.

post /api/v1/icons

תשובות: 200 האייקונים שנמצאו, ושגיאות לכל מזהה שלא נמצא. · 400 לא נשלחו מזהים. · 429 חרגתם ממכסת הבקשות. חכו את מספר השניות שב-`Retry-After`. · 500 שגיאה בשרת.

get /api/v1/collections

• search: סינון לפי מזהה או שם.
• limit: מספר התוצאות המרבי (עד 500, ברירת מחדל 80).

תשובות: 200 הסטים, מהגדול לקטן. · 429 חרגתם ממכסת הבקשות. חכו את מספר השניות שב-`Retry-After`. · 500 שגיאה בשרת.

get /api/v1/similar

• id (חובה): מזהה אייקון בצורה `סט:שם`, למשל `lucide:house`.
• limit: מספר התוצאות המרבי (עד 100, ברירת מחדל 10).

תשובות: 200 אייקונים עם שם זהה או קרוב בסטים אחרים. · 400 חסר `id`. · 429 חרגתם ממכסת הבקשות. חכו את מספר השניות שב-`Retry-After`. · 500 שגיאה בשרת.

get /api/v1/equivalent

• id (חובה): מזהה אייקון בצורה `סט:שם`, למשל `lucide:house`.
• to (חובה): הסט היעד.

תשובות: 200 האייקון המקביל. · 400 חסר `id` או `to`. · 404 אין אייקון מקביל בסט היעד. · 429 חרגתם ממכסת הבקשות. חכו את מספר השניות שב-`Retry-After`. · 500 שגיאה בשרת.