Website reads

Find a website's icon

POST/v1/sites/icon

Find a website's icon, its favicon, without saving anything. A brand keeps its own in avatarUrl. Private and local addresses fail with 400 import_failed, and more than 120 calls an hour fail with 429 rate_limited.

curl -X POST "$AYEFORM_API/v1/sites/icon" \
  -H "Authorization: Bearer $AYEFORM_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://luigispizza.com"
  }'

200 Response

{
  "iconUrl": "https://luigispizza.com"
}

Body

JSON, with Content-Type: application/json.

urlstringrequired
A website address. A bare host such as example.com works.
1–2000 chars
workspaceIdstring
Optional. Your API key already belongs to one workspace.

Response

iconUrlstring or nullrequired
The address of the sharpest icon offered by the site's home page, /favicon.ico or web manifest, checked to be a real image. Null when the site has none or can't be reached.

Errors answer with a status and the error shape.