REST API

प्रमाणीकरण

हर अनुरोध के लिए API कुंजी चाहिए। अपनी प्रोफ़ाइल पेज पर एक बनाएँ और उसे X-API-Key हेडर में भेजें। Authorization: Bearer … भी काम करता है।

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

रेट सीमाएँ

हर कुंजी प्रति घंटे 1,000 अनुरोध कर सकती है। बिना कुंजी वाले अनुरोधों की प्रति IP पते कम सीमा होती है। हर रिस्पॉन्स में X-RateLimit-Limit होता है; सीमा पार करने पर HTTP 429 मिलता है।

रिस्पॉन्स फ़ॉर्मेट

रिस्पॉन्स JSON में होते हैं जिनमें data फ़ील्ड होता है, और सूचियों में पेजिनेशन के लिए meta फ़ील्ड भी।

{
  "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/hi/icon/fingerprint"
    }
  ],
  "meta": { "page": 1, "per_page": 24, "total": 173, "total_pages": 8 }
}

GET /icons

प्रकाशित आइकन की सूची। वेबसाइट जैसे ही फ़िल्टर काम करते हैं।

GET https://iconfold.com/api/icons?category=weather&per_page=2

GET /icons/{id or slug}

टैग, लाइसेंस और SVG मार्कअप के साथ एक आइकन (मुफ़्त आइकन, या आपके खाते के प्रीमियम आइकन)।

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

GET /categories

आइकन संख्या के साथ सभी कैटेगरी।

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

GET /search?q=

नाम, टैग, कीवर्ड और कैटेगरी में पूरा टेक्स्ट खोजें। /icons के फ़िल्टर भी काम करते हैं।

GET https://iconfold.com/api/search?q=arrow

त्रुटियाँ

त्रुटियाँ सामान्य HTTP स्टेटस कोड के साथ आती हैं, जिनकी बॉडी {"error": {"code": 401, "message": "…"}} जैसी होती है: कुंजी न होने या गलत होने पर 401, जो प्रीमियम सामग्री आपकी नहीं है उसके लिए 403, कुछ न मिलने पर 404 और सीमा पार करने पर 429।