एंडपॉइंट
डोमेन को पाथ बनाकर GET रिक्वेस्ट भेजें। रिस्पॉन्स बॉडी ख़ुद इमेज होती है, इसलिए आप URL को सीधे <img> टैग में इस्तेमाल कर सकते हैं।
https://favicon.is/{domain}<img src="https://favicon.is/github.com" width="32" height="32" alt="GitHub">क्वेरी पैरामीटर
| पैरामीटर | टाइप | डिफ़ॉल्ट | विवरण |
|---|---|---|---|
| size | integer | 128 | पिक्सेल में आइकन का साइज़। 16, 32, 48, 64, 128 या 256 में से एक; बाकी मान सबसे नज़दीकी समर्थित साइज़ में राउंड कर दिए जाते हैं।?size=64 |
| larger | boolean | false | हाई-रेज़ोल्यूशन आइकन (256 px) लौटाता है। size=256 के बराबर।?larger=true |
| original | boolean | false | Google के फ़ेविकॉन कैश को छोड़कर वेबसाइट के अपने HTML में घोषित आइकन पढ़ता है।?original=true |
| download | boolean | false | Content-Disposition हेडर भेजता है, ताकि ब्राउज़र आइकन को फ़ाइल के रूप में डाउनलोड करें।?download=1 |
स्वीकार्य इनपुट
आप सिर्फ़ डोमेन, सबडोमेन, पूरा URL या अंतरराष्ट्रीय डोमेन नाम दे सकते हैं। प्रोटोकॉल, www., पोर्ट, पाथ और क्वेरी स्ट्रिंग अपने-आप हटा दिए जाते हैं, और डोमेन का मिलान केस-इनसेंसिटिव तरीके से होता है।
https://favicon.is/github.com
https://favicon.is/docs.github.com
https://favicon.is/https://github.com/features/actions
https://favicon.is/WWW.GitHub.com:443
https://favicon.is/bücher.de
https://favicon.is/例子.中国IANA TLD के साथ डोमेन वैलिडेशन
Favicon.is केवल उन्हीं डोमेन के आइकन फ़ेच करता है जिनका सफ़िक्स IANA रूट ज़ोन डेटाबेस में डेलिगेट किया गया टॉप-लेवल डोमेन (TLD) हो। दूसरे सफ़िक्स, जैसे .local, .test या टाइपो वाली रिक्वेस्ट को किसी सर्वर से संपर्क किए बिना तुरंत डिफ़ॉल्ट आइकन मिलता है।
सभी समर्थित TLD देखेंरिस्पॉन्स
सफल रिक्वेस्ट इमेज के साथ HTTP 200 लौटाती है (आमतौर पर PNG, कभी-कभी ICO या SVG)। अगर कोई आइकन नहीं मिलता, तब भी आपको डिफ़ॉल्ट आइकन के साथ HTTP 200 मिलता है, इसलिए आपके पेज पर कभी टूटी हुई इमेज नहीं दिखती।
$ curl -I https://favicon.is/github.com
HTTP/2 200
content-type: image/png
cache-control: public, max-age=86400, stale-while-revalidate=604800
access-control-allow-origin: *
etag: "8c1f3b6a2d4e5f60718293a4"
x-source: cache-r2
x-response-time: 3msरिस्पॉन्स हेडर
- Content-Type
- इमेज फ़ॉर्मैट: image/png, image/x-icon, image/svg+xml, image/jpeg, image/gif या image/webp।
- Cache-Control
- ब्राउज़र और CDN आइकन को एक दिन तक कैश कर सकते हैं और एक हफ़्ते तक बैकग्राउंड में रीवैलिडेट कर सकते हैं।
- X-Source
- आइकन कहाँ से आया: cache-edge, cache-r2, google, live या default।
- X-Reason
- केवल डिफ़ॉल्ट आइकन पर। वजह बताता है: invalid-domain, unsupported-tld, not-found या failure-cache।
- X-Response-Time
- हमारी तरफ़ रिक्वेस्ट में कितना समय लगा।
- Access-Control-Allow-Origin
- Access-Control-Allow-Origin: * की वजह से आप आइकन को canvas पर ड्रॉ कर सकते हैं या किसी भी origin से फ़ेच कर सकते हैं।
कैशिंग और ताज़गी
हर आइकन Cloudflare R2 में और उसे सर्व करने वाले डेटा सेंटर के एज कैश में स्टोर होता है। दोबारा की गई रिक्वेस्ट में आमतौर पर कुछ ही मिलीसेकंड लगते हैं।
स्टोर किए गए आइकन सात दिन बाद बैकग्राउंड में रिफ़्रेश होते हैं, इसलिए अगर कोई साइट अपना लोगो बदलती है, तो वह किसी को धीमा किए बिना अपने-आप अपडेट हो जाता है।
जब किसी साइट का कोई आइकन ही नहीं होता, तो बार-बार लुकअप करके उस पर बोझ न डालने के लिए यह नतीजा एक घंटे तक याद रखा जाता है।
डिफ़ॉल्ट आइकन
जब कोई आइकन उपलब्ध नहीं होता, तो API यह न्यूट्रल प्लेसहोल्डर लौटाता है। इसे पहचानना हो, तो X-Source हेडर में default मान जाँचें।
$ curl -I https://favicon.is/example.invalid
HTTP/2 200
content-type: image/svg+xml
x-source: default
x-reason: unsupported-tldInspect API (JSON)
फ़ेविकॉन चेकर एक JSON एंडपॉइंट पर चलता है, जो किसी साइट के घोषित हर आइकन की सूची असली पिक्सेल डाइमेंशन के साथ देता है: link टैग, वेब ऐप मैनिफ़ेस्ट और /favicon.ico।
GET https://favicon.is/api/inspect?domain=github.com
{
"domain": "github.com",
"url": "https://github.com/",
"title": "GitHub · Build and ship software on a single, collaborative platform",
"reachable": true,
"icons": [
{
"href": "https://github.githubassets.com/favicons/favicon.svg",
"rel": "icon",
"type": "image/svg+xml",
"source": "link",
"ok": true,
"contentType": "image/svg+xml",
"width": 32,
"height": 32
}
],
"manifest": { "href": "https://github.com/manifest.json", "ok": true, "icons": [ … ] },
"checks": { "ico": true, "svg": true, "appleTouch": true, "manifest": true, "large": true }
}उचित उपयोग
इमेज एंडपॉइंट मुफ़्त है और सामान्य उपयोग के लिए इस पर कोई सख़्त सीमा नहीं है। Inspect API प्रति IP एड्रेस प्रति मिनट 30 रिक्वेस्ट तक सीमित है। अगर आप रोज़ लाखों रिक्वेस्ट भेजने की योजना बना रहे हैं, तो कृपया पहले हमसे संपर्क करें।