https://github.com/snuffydev/favifetch
A website favicon & icon API, powered by Cloudflare Workers
https://github.com/snuffydev/favifetch
api cloudflare cloudflare-workers favicon icon scraper serverless workers
Last synced: 12 months ago
JSON representation
A website favicon & icon API, powered by Cloudflare Workers
- Host: GitHub
- URL: https://github.com/snuffydev/favifetch
- Owner: snuffyDev
- License: apache-2.0
- Created: 2021-11-27T14:51:27.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-16T07:23:12.000Z (about 4 years ago)
- Last Synced: 2025-01-11T16:48:46.962Z (about 1 year ago)
- Topics: api, cloudflare, cloudflare-workers, favicon, icon, scraper, serverless, workers
- Language: TypeScript
- Homepage: https://favifetch.beatbump.workers.dev/
- Size: 131 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE_APACHE
Awesome Lists containing this project
README
# Favifetch
A simple API for fetching a website's icons, as well as metadata from the web app manifest.
## Usage
Make an HTTP GET request to: `https://favifetch.beatbump.workers.dev/get?url=`
Example:
```bash
https://favifetch.beatbump.workers.dev/get?url=github.com
// or with https protocol
https://favifetch.beatbump.workers.dev/get?url=https://github.com
```
## Response
```typescript
{
"icon_urls"?: string[] // Array of icon URLs parsed from the HTML
"manifest_icons"?: {src?: string; purpose?: string; sizes?: string; type?: string}[] // Array of icons parsed from the webmanifest, if found
"manifest_url"?: string // URL Path of the web app manifest, if found
"name"?: string // Web app name from the web app manifest
"theme_color"?: string // Theme color from the web app manifest
}
```