# Structured data and hreflang API

Check a page's JSON-LD, microdata and RDFa against schema.org, and test its hreflang alternates.

`GET /v1/structured-data`

- Price: Costs 2 credits per call; cached answers cost the same. Calls that fail upstream (502) are free.
- Cache: Answers are cached for up to 15 minutes, per account except for a site's home page; send fresh=true to ask the source again.
- MCP tool: `validate_structured_data`

JSON-LD, microdata and RDFa items on a page checked against schema.org rules, and hreflang alternates. Costs 2 credits per call; cached answers cost the same. Calls that fail upstream (502) are free. Answers are cached for up to 15 minutes, per account except for a site's home page; 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 page URL or a domain; a domain means its home page. |
| `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.status` | integer or null | yes |  |
| `data.truncated` | boolean | yes |  |
| `data.items` | array of object | yes |  |
| `data.jsonld_errors` | array of object | yes |  |
| `data.counts` | object | yes |  |
| `data.hreflang` | object | 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/structured-data?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/structured-data", 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/structured-data?${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": "structured-data-validator",
  "target": "https://example.com/",
  "status": "ok",
  "fetched_at": "2026-11-14T10:00:00Z",
  "cached": false,
  "credits_used": 2,
  "summary": "example.com has 3 valid structured data items (Organization, Product and BreadcrumbList). Search engines decide whether to show rich results.",
  "findings": [
    {
      "id": "hreflang.none",
      "severity": "info",
      "title": "No hreflang alternates",
      "detail": "",
      "fix": "Nothing to do unless the site has other language versions."
    },
    {
      "id": "structured_data.valid",
      "severity": "pass",
      "title": "The structured data is valid",
      "detail": "",
      "fix": "Nothing to do; search engines decide whether to show rich results."
    }
  ],
  "data": {
    "url": "https://example.com/",
    "final_url": "https://example.com/",
    "status": 200,
    "truncated": false,
    "items": [
      {
        "syntax": "json-ld",
        "types": [
          "Organization"
        ],
        "id": "https://example.com/#org",
        "properties": [
          "logo",
          "name",
          "sameAs",
          "url"
        ],
        "problems": [],
        "rule": "Organization"
      },
      {
        "syntax": "json-ld",
        "types": [
          "Product"
        ],
        "properties": [
          "brand",
          "description",
          "image",
          "name",
          "offers",
          "sku"
        ],
        "problems": [],
        "rule": "Product"
      },
      {
        "syntax": "json-ld",
        "types": [
          "BreadcrumbList"
        ],
        "properties": [
          "itemListElement"
        ],
        "problems": [],
        "rule": "BreadcrumbList"
      }
    ],
    "jsonld_errors": [],
    "counts": {
      "jsonld": 3,
      "microdata": 0,
      "rdfa": 0
    },
    "hreflang": {
      "sources": {
        "html": 0,
        "header": 0,
        "sitemap": 0
      },
      "alternates": [],
      "self_reference": false,
      "x_default": false,
      "invalid_codes": [],
      "conflicts": [],
      "relative": [],
      "limit_reached": false
    }
  },
  "credits_remaining": 498
}
```

## MCP

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

```text
example.com has 3 valid structured data items (Organization, Product and BreadcrumbList). Search engines decide whether to show rich results.
Items: 3 (JSON-LD 3, microdata 0, RDFa 0)
Organization (json-ld): no problems
Product (json-ld): no problems
BreadcrumbList (json-ld): no problems
hreflang: none
- info: No hreflang alternates
1 check passed
Credits: 2 credits used, 498 remaining | fresh | checked 2026-11-14 10:00 UTC
```
