# Site metadata and logo API

Get a site's logo, icons, title, description, language and social profiles in one go.

`GET /v1/metadata`

- Price: Costs 1 credit per call; cached answers cost the same. Calls that fail upstream (502) are free.
- Cache: Answers are cached for up to 15 minutes; send fresh=true to ask the source again.
- MCP tool: `get_site_metadata`

A site's title, description, language, social profiles, icons and logo. Costs 1 credit per call; cached answers cost the same. Calls that fail upstream (502) are free. Answers are cached for up to 15 minutes; send fresh=true to ask the source again. A retry with the same `X-Request-Id` returns the stored result of the first call for 24 hours without charging again, marked with the `X-Replayed: true` header.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | yes | A domain or URL; only the site (scheme and host) is used. |
| `fresh` | boolean | no | Skip the cache and ask the source again; costs the same. |

## Response

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `tool` | string | yes |  |
| `target` | string | yes |  |
| `status` | "ok" | "partial" | "error" | yes |  |
| `fetched_at` | string | no |  |
| `cached` | boolean | no |  |
| `credits_used` | integer | no | Credits this call took from your balance. 0 for free tools, for a replay of an earlier call, and for a free check run on the website without signing in |
| `summary` | string | yes |  |
| `score` | integer or null | no |  |
| `findings` | array of object | no |  |
| `credits_remaining` | integer | yes | Your balance after this call. It can be below zero after a refund; free tools still work then |
| `data` | object | yes | This tool's result |
| `data.url` | string | yes |  |
| `data.final_url` | string or null | yes |  |
| `data.title` | string or null | yes |  |
| `data.description` | string or null | yes |  |
| `data.canonical` | string or null | yes |  |
| `data.lang` | string or null | yes |  |
| `data.site_name` | string or null | yes |  |
| `data.social_profiles` | array of object | yes |  |
| `data.icons` | array of object | yes |  |
| `data.icons.url` | string | yes |  |
| `data.icons.source` | "jsonld" | "apple-touch-icon" | "icon" | "manifest" | "og:image" | "favicon.ico" | yes |  |
| `data.icons.declared_sizes` | string or null | yes |  |
| `data.icons.info` | object or null | yes |  |
| `data.icons.status` | integer or null | yes |  |
| `data.icons.display` | string or null | yes |  |
| `data.icons.problem` | string or null | yes |  |
| `data.logo` | object or null | yes |  |
| `data.manifest` | object or null | yes |  |

## Errors

- `400` Invalid domain, URL or parameter, a TLD this tool can't check, or an X-Request-Id already used for another call (`invalid_domain`, `invalid_url`, `invalid_request`, `unsupported_tld`)
- `401` Missing, unknown or revoked API key, or one whose creator is no longer a member of the account (`unauthorized`)
- `402` Balance below the call's price (`insufficient_credits`)
- `403` Account suspended, the key's creator is over the plan's seats, or an anonymous check without a valid proof-of-work or for a tool that needs an account, or bulk checks before a first purchase (`account_suspended`, `plan_limit`, `challenge_required`, `sign_in_required`, `bulk_locked`)
- `429` Too many requests, today's free checks are used up, or too many website scans at once; wait for the number of seconds in the Retry-After header (`rate_limited`, `free_limit_reached`, `too_many_jobs`). Not charged
- `500` Unexpected error (`internal_error`)
- `502` Every upstream source failed; not charged (`source_unavailable`). A Retry-After header says how long to wait when the source asked us to
- `503` Too many open event streams on this server, the checked site is getting too many checks, or the browser or link checker is busy; try again after the seconds in the Retry-After header (`busy`, `site_busy`, `browser_busy`, `crawl_busy`). Not charged

## Example

```sh
curl "https://api.dnssuper.com/v1/metadata?url=example.com" \
  -H "Authorization: Bearer $DNSSUPER_API_KEY"
```

```python
import os

import httpx

client = httpx.Client(
    base_url="https://api.dnssuper.com",
    headers={"Authorization": f"Bearer {os.environ['DNSSUPER_API_KEY']}"},
    timeout=60,
)
response = client.get("/v1/metadata", params={
    "url": "example.com",
})
response.raise_for_status()
result = response.json()
print(result["summary"], result["credits_used"])
```

```ts
const response = await fetch(`https://api.dnssuper.com/v1/metadata?${new URLSearchParams({"url":"example.com"})}`, {
  headers: { Authorization: `Bearer ${process.env.DNSSUPER_API_KEY}` },
});
if (!response.ok) throw new Error((await response.json()).error.message);
const result = await response.json();
console.log(result.summary, result.credits_used);
```

Example response:

```json
{
  "tool": "website-logo",
  "target": "https://example.com/",
  "status": "ok",
  "fetched_at": "2026-11-14T10:00:00Z",
  "cached": false,
  "credits_used": 1,
  "summary": "example.com has a title, a description and 6 working icons. The logo comes from its structured data.",
  "findings": [],
  "data": {
    "url": "https://example.com/",
    "final_url": "https://example.com/",
    "title": "Example Widgets",
    "description": "Widgets for every workshop.",
    "canonical": "https://example.com/",
    "lang": "en",
    "site_name": "Example",
    "social_profiles": [
      {
        "network": "linkedin",
        "url": "https://www.linkedin.com/company/example"
      },
      {
        "network": "github",
        "url": "https://github.com/example"
      },
      {
        "network": "x",
        "url": "https://x.com/example"
      },
      {
        "network": "youtube",
        "url": "https://www.youtube.com/@example"
      },
      {
        "network": "mastodon",
        "url": "https://social.example.net/@example"
      }
    ],
    "icons": [
      {
        "url": "https://cdn.example.net/brand/logo.png",
        "source": "jsonld",
        "info": {
          "format": "png",
          "width": 512,
          "height": 512,
          "bytes": 1512,
          "content_type": "image/png",
          "type_matches": true,
          "animated": false
        },
        "status": 200,
        "display": "data:image/webp;base64,UklGRpYAAABXRUJQVlA4IIoAAADwBwCdASpAAEAAPm02mEkkIyKhIggAgA2JaQDU9oAYroB6IBXT8uhI87xkk7LXCfidhRJ3fJO7UgJi8BTpO3ZWPDtkGIBUjegA/vwTUuRd1KX//G8eBXkuyv//FtI6FTlGbaJw+rT21LXD6ufBfoLnyiEKXL5JHcWzTUwj29wQFOT2Gy55CTlgAAA="
      },
      {
        "url": "https://example.com/apple-touch-icon.png",
        "source": "apple-touch-icon",
        "declared_sizes": "180x180",
        "info": {
          "format": "png",
          "width": 180,
          "height": 180,
          "bytes": 400,
          "content_type": "image/png",
          "type_matches": true,
          "animated": false
        },
        "status": 200,
        "display": "data:image/webp;base64,UklGRtYAAABXRUJQVlA4IMoAAAAQCACdASpAAEAAPm0sk0ckIiGhqBQN+IANiWcA0bHu+AL//z/wP/SrPzCC/7Saq/4GWg33W4RtgSuVgF7tOU0CJ8hNPOemipyAAP7zYCWTPiCb/oBjlzJ//iLA/St+UKb1n/i3xB62uWAZQ+57uqV/39vuJVtwBTWwOxUrKQf5+Vsmnowbjfsw4INvv5DXBdV+K2dPsOUGJpC2cy+LcixtfRlBvohF4l+caxXrV7WzBeRtkkE8nfeFGtMhABWaCO7qrQlTTnK5CgAA"
      },
      {
        "url": "https://example.com/favicon.svg",
        "source": "icon",
        "info": {
          "format": "svg",
          "width": 64,
          "height": 64,
          "bytes": 201,
          "content_type": "image/svg+xml",
          "type_matches": true,
          "animated": false
        },
        "status": 200,
        "display": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI2NCIgaGVpZ2h0PSI2NCIgdmlld0JveD0iMCAwIDY0IDY0Ij48dGl0bGU+RXhhbXBsZTwvdGl0bGU+PHJlY3Qgd2lkdGg9IjY0IiBoZWlnaHQ9IjY0IiBmaWxsPSIjMWU1YWEwIiAvPjxjaXJjbGUgY3g9IjMyIiBjeT0iMzIiIHI9IjIwIiBmaWxsPSIjZmZmIiAvPjwvc3ZnPg=="
      },
      {
        "url": "https://example.com/favicon-32.png",
        "source": "icon",
        "declared_sizes": "32x32",
        "info": {
          "format": "png",
          "width": 32,
          "height": 32,
          "bytes": 114,
          "content_type": "image/png",
          "type_matches": true,
          "animated": false
        },
        "status": 200,
        "display": "data:image/webp;base64,UklGRqoAAABXRUJQVlA4IJ4AAADwBwCdASogACAAPm0ylEgkIqIhKAgAgA2JQBdl9i9ApgOAB//8T/3QD+zb//1f7tAfgBHgP4B+QF2A/gH3Ab3+EmYmn46+wCgA/adpy3kB1GNCAC6k12ERw/656MAUYApjs39HIAOC1Vr0ydAzXpU2i0zS6d58vFWRKLX+kK6vrekoBBf0inU6v3YxytXk9XPI7MfoCEEABWYPBJAAAA=="
      },
      {
        "url": "https://example.com/icon-512.png",
        "source": "manifest",
        "declared_sizes": "512x512",
        "info": {
          "format": "png",
          "width": 512,
          "height": 512,
          "bytes": 1512,
          "content_type": "image/png",
          "type_matches": true,
          "animated": false
        },
        "status": 200,
        "display": "data:image/webp;base64,UklGRowAAABXRUJQVlA4IIAAAADwBgCdASpAAEAAPm02mEkkIqKkIggAgA2JZwDU9oB+AA8gACnHhcCRU7ypKneVJU7zfuONzwoxPg7PB8bOc7NgAP7sfoH/V120//8lNf425av/33oDeL/CcUj2u5+QhEJZOteXaVLxyq8VzQ0HGMxX+48h36myNr0sVpQcpVlIAA=="
      },
      {
        "url": "https://example.com/favicon.ico",
        "source": "favicon.ico",
        "info": {
          "format": "ico",
          "width": 48,
          "height": 48,
          "bytes": 421,
          "content_type": "image/x-icon",
          "type_matches": true,
          "animated": false
        },
        "status": 200,
        "display": "data:image/webp;base64,UklGRkYAAABXRUJQVlA4IDoAAAAwAwCdASowADAAPm02mEkkIyKhI4gAgA2JZwAAHdTYOy0AAP7wOEP3uWikV//8wT/3+/7/eS4AAAAA"
      }
    ],
    "logo": {
      "url": "https://cdn.example.net/brand/logo.png",
      "source": "jsonld",
      "format": "png",
      "width": 512,
      "height": 512,
      "fallback": false,
      "png_256": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAIAAADTED8xAAACKklEQVR42u3Tuw1AYACFUa/8UWh1ClvYwFDGkCjMoFFbQgzkUWiVColzBrjFTb64G5Z+WvOQRm/bj7Mqi7apx3nLQ2bf/qf2b0kEPyYABAACAAGAAEAAIAAQAAgABAACAAGAAEAAIAAQAAgABAACAAGAAEAAIAAQAAgABAACAAGAAEAAIAAQAAgABAACAAGAAEAAIAAQAAgABAACAAGAAEAAIAAQAAgABAACAAEgABAACAAEAAIAAYAAQAAgABAACAAEAAIAAYAAQAAgABAACAAEAAIAAYAAQAAgABAACAAEAAIAAYAAQAAgABAACAAEAAIAAYAAQAAgABAACAAEAAIAAYAAQAAgABAACAAEgABAACAAEAAIAAQAAgABgABAACAAEAAIAAQAAgABgABAACAAEAAIAAQAAgABgABAACAAEAAIAAQAAgABgABAACAAEAAIAAQAAgABgABAACAAEAAIAAQAAgABgABAACAABOACBAACAAGAAEAAIAAQAAgABAACAAGAAEAAIAAQAAgABAACAAGAAEAAIAAQAAgABAACAAGAAEAAIAAQAAgABAACAAGAAEAAIAAQAAgABAACAAGAAEAAIAAQAAgABAACAAEgABAACAAEAAIAAYAAQAAgABAACAAEAAIAAYAAQAAgABAACAAEAAIAAYAAQAAgABAACAAEAAIAAYAAQAAgABAACAAEAAIAAYAAQAAgABAACAAEAAIAAYAA4MkFFUQv5qzPL3gAAAAASUVORK5CYII=",
      "png_128": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAIAAABMXPacAAAA7ElEQVR42u3RuwmAUBREQX9gIIK5qb1YjVVZjfBisQPt4hq8AhTEbE680U45L+u2n01dFU9FRN+10zik47L/vs+93emnAAAAIAAABACAAAAQAAACAEAAAAgAAAEAIAAABACAAAAQAAACAEAAAAgAAAEAIAAABACAAAAQAAACAEAAAAgAAAEAIAAABACAAAAQAAACAEAAAAgAAAAuAABAAAAIAAABACAAAAQAgAAAEAAAAgBAAAAIAAABACAAAAQAgAAAEAAAAgBAAAAIAAABACAAAAQAgAAAEAAAAgBAAAAIAAABACAAAAQAgHI34iUu5hZH/78AAAAASUVORK5CYII=",
      "svg_removed": []
    },
    "manifest": {
      "name": "Example Widgets",
      "short_name": "Example",
      "theme_color": "#1e5aa0",
      "background_color": "#ffffff",
      "icons": [
        {
          "src": "https://example.com/icon-192.png",
          "sizes": "192x192",
          "type": "image/png"
        },
        {
          "src": "https://example.com/icon-512.png",
          "sizes": "512x512",
          "type": "image/png"
        }
      ]
    }
  },
  "credits_remaining": 498
}
```

## MCP

```json
{
  "tool": "get_site_metadata",
  "arguments": {
    "url": "example.com"
  }
}
```

```text
example.com has a title, a description and 6 working icons. The logo comes from its structured data.
Title: Example Widgets
Description: Widgets for every workshop.
Language: en | Site name: Example
Social: linkedin, github, x, youtube, mastodon
Icons: 6 checked, 6 working
Logo: from structured data, png 512 x 512
Logo copy: 256x256 PNG
No issues found.
Credits: 1 credit used, 498 remaining | fresh | checked 2026-11-14 10:00 UTC
```
