### What is it? SEO Snapshot API is a lightweight Cloudflare Workers service that returns a structured JSON audit for any publicly reachable web page. It combines user-agent spoofing, optional pre-rendering, and fast HTML parsing (cheerio) to surface: * **Core meta** – title, meta description, canonical, language * **OpenGraph & all `` tags** * **Headings** (`h1…h6`) & counts * **Link audit** – internal / external / no-follow / *broken* (HEAD probe on first 10) * **Robots & canonical status** * **Word / image counts & missing-alt check** * **JSON-LD / Schema.org summaries** * **Hreflang pairs** * An **`seo` convenience node** highlighting common issues (long titles, missing alt, etc.) Typical use-cases: * Build a bulk on-page checker for client sites * Trigger health alerts when pages suddenly lose canonical tags * Pre-screen partner/affiliate pages before publishing links * Drive dashboards that surface broken external links or missing alt attributes --- ## 📚 End-point Docs ### 1. GET `/snapshot` | Parameter | In | Type | Required | Description | |-----------|----|------|----------|-------------| | `url` | query | string | **Yes** | Full URL to analyse (`https://…`) | | `prerender` | query | `"1"` | No | Force prerender fallback even if page isn’t a JS-shell | | *RapidAPI headers* | header | string | **Yes** | `X-RapidAPI-Key`, `X-RapidAPI-Host` (auto-injected) | #### Success - 200 OK ```jsonc { "url": "https://example.com", "title": "Example Domain", "metaDescription": "This domain is for use in illustrative examples ...", "canonical": "https://example.com/", "lang": "en", "pageSizeKb": 8.7, "wordCount": 98, "imageCount": 1, "metaTags": { "description": "...", "og:title": "Example Domain", ... }, "ogTags": { "og:title": "Example Domain", ... }, "headings": [ { "tag": "h1", "text": "Example Domain" } ], "headingCounts": { "h1": 1 }, "linkStats": { "internalLinks": 1, "externalLinks": 1, "nofollowCount": 0, "brokenCount": 0 }, "jsonLd": [], "hreflangs": [], "seo": { "titleLength": 15, "titleTooLong": false, "metaDescriptionLength": 63, "metaDescriptionTooLong": false, "h1Count": 1, "imagesWithAlt": 1, "imagesMissingAlt": 0, "robotsDirectives": [], "canonicalStatus": "self", "hasOgTags": true, "hasJsonLd": false, "wordCount": 98, "internalLinks": 1, "externalLinks": 1, "nofollowCount": 0, "brokenCount": 0 }, "prerendered": false } ``` #### Common Errors | Code | Meaning | Body example | |------|---------|--------------| | **400** | `Missing ?url=` | `{ "error": "Missing ?url=" }` | | **423** | Site behind bot-check / returns ≥ 400 | `{ "error": "Site is protected by a bot-check or returned an error" }` | | **500** | Unexpected fetch/parse failure | `{ "error": "Failed to fetch or parse page", "detail": "…message…" }` | --- ## 🧑‍💻 Code Snippets (Docs → “Code” tab)

cURL

```bash curl --get \ --url 'https://seo-snapshot-api..workers.dev/snapshot' \ --data-urlencode 'url=https://example.com' \ -H 'X-RapidAPI-Key: ' \ -H 'X-RapidAPI-Host: seo-snapshot-api.p.rapidapi.com' ```

Node (fetch)

```js import fetch from "node-fetch"; const res = await fetch( "https://seo-snapshot-api.p.rapidapi.com/snapshot?url=https://example.com", { headers: { "X-RapidAPI-Key": process.env.RAPID_KEY, "X-RapidAPI-Host": "seo-snapshot-api.p.rapidapi.com" } } ); console.log(await res.json()); ```