Reference / SEO Audit

SEO Audit API reference

Audit the HTML of a single public page and get back everything an SEO review needs, without a headless browser.

What one call returns: status and timing for the fetch, the final URL after redirects, title and meta description with length warnings, canonical, robots directives, lang, charset, viewport, H1-H6 counts with the first three headings of each level, image and alt-text counts, internal vs external link counts, word count, text-to-HTML ratio, Flesch reading ease and grade level, Open Graph and Twitter card completeness, JSON-LD types, hreflang entries, HTTPS, response compression, and a 0-100 score built from 14 weighted checks whose weights sum to exactly 100.

Other endpoints: head metadata only, every anchor with rel attributes, keyword frequency with density, readability on its own, robots.txt parsing and sitemap.xml parsing. POST /v1/text runs the readability and keyword analysis on text you already have, with no network call.

Honest scope: this API audits a single public page's HTML. It does not crawl a whole site, does not render JavaScript (so client-side injected tags are invisible to it), and does not measure Core Web Vitals, Lighthouse metrics or real-user performance. Word and syllable statistics target Latin-script languages; CJK word segmentation is not implemented.

Built for: SEO agencies doing first-pass page reviews, SaaS products embedding a site audit feature, growth marketers checking metadata before a launch.

Try it live Open the listing Read the guide

Auth

Two headers on every call. The marketplace rejects requests without them before they reach the API.

X-RapidAPI-Key: YOUR_KEY
X-RapidAPI-Host: seoaudit.p.rapidapi.com

Errors

Every failure returns the same envelope, with a requestId you can quote to support.

{ "error": { "code": "INVALID_INPUT", "message": "...", "hint": "..." }, "requestId": "uuid", "timestamp": "ISO-8601" }

8 endpoints

GET /v1/audit

Run a full weighted on-page audit of one URL

Fetches the page (10 s timeout, 2 MB cap, redirects followed through the SSRF-safe fetcher) and returns title and meta description with length warnings, canonical, robots directives, lang, charset, viewport, H1-H6 counts with the first three headings of each level, image and alt-text counts, internal vs external link counts, word count, text-to-HTML ratio, Flesch reading ease and grade, Open Graph and Twitter completeness, JSON-LD types, hreflang entries, HTTPS, compression, timings, and a 0-100 score from 14 weighted checks that always sum to 100. Pages that return 4xx/5xx are still parsed and the status is reported.

ParameterInTypeDescription
urlquerystring (required)Absolute http(s) URL of the page to audit. A bare hostname is upgraded to https://.
curl example
curl -s -X GET 'https://seo-audit.ayamk.in/v1/audit' \
  -H 'X-RapidAPI-Key: YOUR_KEY' \
  -H 'X-RapidAPI-Host: seoaudit.p.rapidapi.com'
GET /v1/meta

Extract head metadata, social cards and structured data

Returns only the document head: title, meta description, canonical, robots meta, lang, charset, viewport, theme-color, every og: and twitter: tag with a completeness summary, one parsed summary per JSON-LD block, favicon links and hreflang entries. The same 2 MB cap and 10 s timeout apply.

ParameterInTypeDescription
urlquerystring (required)Page whose head metadata should be extracted.
curl example
curl -s -X GET 'https://seo-audit.ayamk.in/v1/meta' \
  -H 'X-RapidAPI-Key: YOUR_KEY' \
  -H 'X-RapidAPI-Host: seoaudit.p.rapidapi.com'
GET /v1/keywords

Rank keywords and phrases with frequency and density

Accepts either ?url= (visible text is extracted from the page) or ?text= (raw text, no network). Returns single words and two word phrases after stopword removal, each with occurrences, density percentage and an IDF-style importance score, plus density percentages for the top ten. The ranking uses a bundled frequency prior, not a live corpus.

ParameterInTypeDescription
urlquerystringFetch this page and analyse its visible text. Send either url or text, not both.
textquerystringAnalyse this raw text instead of fetching a URL (max 20,000 characters in a query string; POST /v1/text accepts up to 100,000).
limitqueryintegerHow many ranked terms to return (1-100, default 20).
curl example
curl -s -X GET 'https://seo-audit.ayamk.in/v1/keywords' \
  -H 'X-RapidAPI-Key: YOUR_KEY' \
  -H 'X-RapidAPI-Host: seoaudit.p.rapidapi.com'
GET /v1/readability

Score readability with Flesch, Flesch-Kincaid and Gunning Fog

Accepts either ?url= or ?text=. Returns Flesch reading ease (0-100), Flesch-Kincaid grade, Gunning Fog index, word/sentence/paragraph/syllable counts, average words per sentence, the longest sentence with its position, and a passive-voice hint count. Syllables are counted heuristically, so treat grades as estimates.

ParameterInTypeDescription
urlquerystringFetch this page and score its visible text. Send either url or text, not both.
textquerystringScore this raw text instead of fetching a URL (max 20,000 characters in a query string).
curl example
curl -s -X GET 'https://seo-audit.ayamk.in/v1/readability' \
  -H 'X-RapidAPI-Key: YOUR_KEY' \
  -H 'X-RapidAPI-Host: seoaudit.p.rapidapi.com'
GET /v1/robots

Fetch and parse a domain's robots.txt

Fetches only <origin>/robots.txt and returns the user-agent groups with their allow/disallow rules and line numbers, crawl-delay, sitemap URLs, the non-standard Host value and any directives that were ignored. A missing file returns found=false with its status code instead of an error. Gzipped or HTML responses are reported, never parsed as rules.

ParameterInTypeDescription
domainquerystring (required)Domain to inspect, with or without scheme. Only /robots.txt is fetched.
curl example
curl -s -X GET 'https://seo-audit.ayamk.in/v1/robots' \
  -H 'X-RapidAPI-Key: YOUR_KEY' \
  -H 'X-RapidAPI-Host: seoaudit.p.rapidapi.com'
GET /v1/sitemap

Parse a sitemap or sitemap index

Fetches one sitemap URL and parses it as an <urlset> (up to 500 URLs with lastmod, changefreq and priority), a <sitemapindex> (up to 200 child sitemaps) or a plain text URL list. It does not follow child sitemaps. Gzipped .xml.gz files are rejected with 415; pass the decompressed XML URL.

ParameterInTypeDescription
urlquerystring (required)Absolute URL of a sitemap.xml or sitemap index. Gzipped (.xml.gz) files are rejected.
curl example
curl -s -X GET 'https://seo-audit.ayamk.in/v1/sitemap' \
  -H 'X-RapidAPI-Key: YOUR_KEY' \
  -H 'X-RapidAPI-Host: seoaudit.p.rapidapi.com'
POST /v1/text

Run readability and keyword analysis on raw text

No network call. Send up to 100,000 characters of text and receive the readability metrics and keyword ranking in one response. Larger payloads are rejected with 413, and JSON bodies above 512 KB are rejected before parsing.

Request body

{
  "text": "Keyword research is the practice of finding the terms people type into search engines. Good research starts with intent.",
  "limit": 20
}
curl example
curl -s -X POST 'https://seo-audit.ayamk.in/v1/text' \
  -H 'X-RapidAPI-Key: YOUR_KEY' \
  -H 'X-RapidAPI-Host: seoaudit.p.rapidapi.com' \
  -H 'Content-Type: application/json' \
  -d '{"text": "Keyword research is the practice of finding the terms people type into search engines. Good research starts with intent.", "limit": 20}'

Generated from seo-audit.ayamk.in/openapi.json on 2026-11-22. If the page and the spec ever disagree, the spec is right.