{"openapi":"3.1.0","info":{"title":"AY Rank Free Tools API","version":"1.0.0","summary":"Free JSON API for AY Rank SEO and GEO tools.","description":"Public JSON versions of the free tools at https://www.ayrank.com/tools. Every endpoint takes GET with query parameters or POST with a JSON body (max 32768 bytes). Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools. Each success response includes a poweredBy link back to the tool page.","termsOfService":"https://www.ayrank.com/terms","contact":{"name":"AY Rank","url":"https://www.ayrank.com"}},"servers":[{"url":"https://www.ayrank.com"}],"tags":[{"name":"llms.txt","description":"Build an llms.txt file for AI crawlers."},{"name":"Titles","description":"Score page titles for click-through and AI citation."},{"name":"robots.txt","description":"Build a robots.txt file with AI crawler rules."},{"name":"Sitemaps","description":"Validate an XML sitemap or sitemap index and check the status of a sample of its URLs."},{"name":"Hreflang","description":"Check a page's hreflang set and whether its alternates link back."},{"name":"E-E-A-T signals","description":"List the trust signals an article shows: byline, author page, schema, dates, About and Contact links, sources. No score."},{"name":"Heading outline","description":"List a page's h1 to h6 headings in order, with skipped levels, empty and image-only headings flagged."},{"name":"Broken links","description":"Check the status of every link on one page: broken, server error, refused, redirect or fine."},{"name":"HTTP headers","description":"List a URL's status line and every response header, hop by hop, with the search headers explained. No score."},{"name":"Page size","description":"Measure a URL's transferred and uncompressed size against Googlebot's 2 MB limit, with what sits past the cut. No score."},{"name":"IndexNow","description":"Check an IndexNow key file, then submit URLs to the IndexNow API after the key file passes."},{"name":"AI preferences","description":"Read the AI training and grounding preferences a page expresses."},{"name":"robots.txt testing","description":"Test whether a crawler may fetch a URL under a site's robots.txt."},{"name":"AI crawler access","description":"Check whether GPTBot, ClaudeBot, PerplexityBot and Google-Extended may crawl a site under its robots.txt."},{"name":"AI crawler IP ranges","description":"The published IP ranges of AI and search crawlers, for checking server logs."}],"paths":{"/api/v1/llms-txt-generator":{"get":{"tags":["llms.txt"],"summary":"Generate an llms.txt file","description":"Returns an llms.txt file built from your company details, plus a completeness score. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/llms-txt-generator"},"operationId":"llmsTxtGeneratorGet","parameters":[{"name":"companyName","in":"query","required":true,"description":"Company name.","schema":{"type":"string"}},{"name":"websiteUrl","in":"query","required":true,"description":"Absolute http(s) URL of the site.","schema":{"type":"string"}},{"name":"description","in":"query","required":false,"description":"Two or three sentences on what the company does.","schema":{"type":"string"}},{"name":"industry","in":"query","required":false,"description":"Industry, for example SaaS or Healthcare.","schema":{"type":"string"}},{"name":"services","in":"query","required":false,"description":"Comma-separated list of services.","schema":{"type":"string"}},{"name":"keyPages","in":"query","required":false,"description":"Key page URLs, one per line (or repeat the parameter).","schema":{"type":"string"}},{"name":"differentiators","in":"query","required":false,"description":"What makes the company different, one per line (or repeat the parameter).","schema":{"type":"string"}},{"name":"contactEmail","in":"query","required":false,"description":"Contact email.","schema":{"type":"string"}},{"name":"socialLinks","in":"query","required":false,"description":"Comma-separated social profile URLs.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LlmsTxtResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["llms.txt"],"summary":"Generate an llms.txt file","description":"Returns an llms.txt file built from your company details, plus a completeness score. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/llms-txt-generator"},"operationId":"llmsTxtGeneratorPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LlmsTxtRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LlmsTxtResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/title-scorer":{"get":{"tags":["Titles"],"summary":"Score a page title","description":"Scores a title from 0 to 100 on eight factors (length, power words, numbers, emotion, question format, readability, AI citability, uniqueness) with a tip for each. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/title-scorer"},"operationId":"titleScorerGet","parameters":[{"name":"title","in":"query","required":true,"description":"The title to score, up to 300 characters.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TitleScoreResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["Titles"],"summary":"Score a page title","description":"Scores a title from 0 to 100 on eight factors (length, power words, numbers, emotion, question format, readability, AI citability, uniqueness) with a tip for each. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/title-scorer"},"operationId":"titleScorerPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TitleScoreRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TitleScoreResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/robots-txt-generator":{"get":{"tags":["robots.txt"],"summary":"Generate a robots.txt file","description":"Returns a robots.txt file. Every known crawler is allowed unless listed in block. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/robots-txt-generator"},"operationId":"robotsTxtGeneratorGet","parameters":[{"name":"block","in":"query","required":false,"description":"Comma-separated crawlers to disallow. Known: GPTBot, OAI-SearchBot, ChatGPT-User, ClaudeBot, PerplexityBot, Google-Extended, Applebot-Extended, Googlebot, Bingbot.","schema":{"type":"string"}},{"name":"blockedDirs","in":"query","required":false,"description":"Comma-separated paths to disallow for every crawler, like /admin,/private.","schema":{"type":"string"}},{"name":"sitemapUrl","in":"query","required":false,"description":"Absolute http(s) URL of the sitemap.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RobotsTxtResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["robots.txt"],"summary":"Generate a robots.txt file","description":"Returns a robots.txt file. Every known crawler is allowed unless listed in block. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/robots-txt-generator"},"operationId":"robotsTxtGeneratorPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RobotsTxtRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RobotsTxtResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/sitemap-validator":{"get":{"tags":["Sitemaps"],"summary":"Validate an XML sitemap","description":"Reads a sitemap URL, or for a site root the Sitemap lines in its robots.txt (else /sitemap.xml), and checks it against the sitemaps.org protocol and Google's sitemap rules: urlset or sitemapindex root in the 0.9 namespace, loc present, absolute, under 2,048 characters and on the sitemap's host and folder, entity escaping, UTF-8, 50,000 entries and 50 MB uncompressed, lastmod in W3C Datetime and not in the future, changefreq and priority values. For an index it reads up to 10 child sitemaps with the same checks. It then sends HEAD (GET with a small range when HEAD fails) to up to 20 URLs picked evenly across the file, following up to 5 redirects. Caps: 10 MB read per file (gzip unpacked up to the same cap), 6 s per request, 20 s per call, 4 requests at a time. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A sitemap that answers 4xx or 5xx returns 200 with sitemap.status set and sitemap.report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/sitemap-validator"},"operationId":"sitemapValidatorGet","parameters":[{"name":"url","in":"query","required":true,"description":"A sitemap URL like https://example.com/sitemap.xml, or a site root like https://example.com.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitemapValidatorResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["Sitemaps"],"summary":"Validate an XML sitemap","description":"Reads a sitemap URL, or for a site root the Sitemap lines in its robots.txt (else /sitemap.xml), and checks it against the sitemaps.org protocol and Google's sitemap rules: urlset or sitemapindex root in the 0.9 namespace, loc present, absolute, under 2,048 characters and on the sitemap's host and folder, entity escaping, UTF-8, 50,000 entries and 50 MB uncompressed, lastmod in W3C Datetime and not in the future, changefreq and priority values. For an index it reads up to 10 child sitemaps with the same checks. It then sends HEAD (GET with a small range when HEAD fails) to up to 20 URLs picked evenly across the file, following up to 5 redirects. Caps: 10 MB read per file (gzip unpacked up to the same cap), 6 s per request, 20 s per call, 4 requests at a time. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A sitemap that answers 4xx or 5xx returns 200 with sitemap.status set and sitemap.report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/sitemap-validator"},"operationId":"sitemapValidatorPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitemapValidatorRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitemapValidatorResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/hreflang-checker":{"get":{"tags":["Hreflang"],"summary":"Check a page's hreflang tags","description":"Reads the hreflang set of one page from the link rel=\"alternate\" hreflang tags in its HTML head and from the HTTP Link header (sitemap hreflang is not read), and checks it against Google's \"Tell Google about localized versions of your page\": ISO 639-1 language, optional ISO 15924 script and ISO 3166-1 alpha-2 region, case-insensitive; no region alone; reserved regions like UK, EU and UN; a self-reference; x-default (a warning when missing); one URL per value; fully qualified URLs; tags inside head. It then reads up to 10 alternate URLs, 4 at a time, and reports each one's status, whether it links back to the page and whether its canonical points to itself. Caps: 2 MB read per page, 6 s per request, 20 s per call, 5 redirects. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A page that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/hreflang-checker"},"operationId":"hreflangCheckerGet","parameters":[{"name":"url","in":"query","required":true,"description":"The page to check, like https://example.com/page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HreflangCheckerResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["Hreflang"],"summary":"Check a page's hreflang tags","description":"Reads the hreflang set of one page from the link rel=\"alternate\" hreflang tags in its HTML head and from the HTTP Link header (sitemap hreflang is not read), and checks it against Google's \"Tell Google about localized versions of your page\": ISO 639-1 language, optional ISO 15924 script and ISO 3166-1 alpha-2 region, case-insensitive; no region alone; reserved regions like UK, EU and UN; a self-reference; x-default (a warning when missing); one URL per value; fully qualified URLs; tags inside head. It then reads up to 10 alternate URLs, 4 at a time, and reports each one's status, whether it links back to the page and whether its canonical points to itself. Caps: 2 MB read per page, 6 s per request, 20 s per call, 5 redirects. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A page that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/hreflang-checker"},"operationId":"hreflangCheckerPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HreflangCheckerRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HreflangCheckerResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/broken-link-checker":{"get":{"tags":["Broken links"],"summary":"Check every link on a page","description":"Reads one page, finds its <a href> links (deduped by URL without the fragment, mailto, tel, javascript and same-page links left out, at most 100) and sends one GET to each, 4 at a time, body discarded. Each link gets an outcome: ok, redirect, broken (4xx other than 401, 403 and 429; Google treats these as content that doesn't exist), denied (401, 403, or a code above 599 such as LinkedIn's 999), rate-limited (429), server-error (5xx), too-many-redirects, timeout, network, blocked (private address, not requested) or skipped (the 25 s budget ran out). Caps: 2 MB page read, 6 s per request, 5 redirects per request. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid page URL returns 400. A page that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/broken-link-checker"},"operationId":"brokenLinkCheckerGet","parameters":[{"name":"url","in":"query","required":true,"description":"The page whose links to check, like https://example.com/page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrokenLinkResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["Broken links"],"summary":"Check every link on a page","description":"Reads one page, finds its <a href> links (deduped by URL without the fragment, mailto, tel, javascript and same-page links left out, at most 100) and sends one GET to each, 4 at a time, body discarded. Each link gets an outcome: ok, redirect, broken (4xx other than 401, 403 and 429; Google treats these as content that doesn't exist), denied (401, 403, or a code above 599 such as LinkedIn's 999), rate-limited (429), server-error (5xx), too-many-redirects, timeout, network, blocked (private address, not requested) or skipped (the 25 s budget ran out). Caps: 2 MB page read, 6 s per request, 5 redirects per request. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid page URL returns 400. A page that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/broken-link-checker"},"operationId":"brokenLinkCheckerPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrokenLinkRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrokenLinkResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/heading-outline-checker":{"get":{"tags":["Heading outline"],"summary":"List a page's heading outline","description":"Reads one page and lists its h1 to h6 headings in document order (at most 500), each with its level, the text a screen reader would announce (own text, else aria-label, else image alt text), the landmark it sits in, and whether it is inside hgroup. Issues: no headings, no h1 (WHATWG: at least one heading should have level 1), skipped levels (WHATWG: each heading must be at most 1 level deeper than the one before; going back up any number of levels is fine), empty headings, image-only headings, and more than one h1 (a note only: Google says there is no ideal number of headings and order does not matter to Google Search). Caps: 2 MB read, 6 s per request, 20 s per call, 5 redirects. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A page that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/heading-outline-checker"},"operationId":"headingOutlineCheckerGet","parameters":[{"name":"url","in":"query","required":true,"description":"The page to check, like https://example.com/page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HeadingOutlineResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["Heading outline"],"summary":"List a page's heading outline","description":"Reads one page and lists its h1 to h6 headings in document order (at most 500), each with its level, the text a screen reader would announce (own text, else aria-label, else image alt text), the landmark it sits in, and whether it is inside hgroup. Issues: no headings, no h1 (WHATWG: at least one heading should have level 1), skipped levels (WHATWG: each heading must be at most 1 level deeper than the one before; going back up any number of levels is fine), empty headings, image-only headings, and more than one h1 (a note only: Google says there is no ideal number of headings and order does not matter to Google Search). Caps: 2 MB read, 6 s per request, 20 s per call, 5 redirects. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A page that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/heading-outline-checker"},"operationId":"headingOutlineCheckerPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HeadingOutlineRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HeadingOutlineResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/alt-text-checker":{"get":{"tags":["Image alt text"],"summary":"List the images on a page with their alt text","description":"Reads one page and lists its images in page order (at most 500): img, input type=image, area with href, and inline svg with role=\"img\" (other inline svg is counted, not checked). Each image has a resolved src (src, else data-src, data-lazy-src, data-original or the first srcset candidate), its alt text and a state: missing (no alt attribute), empty (alt=\"\", decorative), present, or hidden (aria-hidden=\"true\" on it or a parent, or role presentation or none). Flags: missing-alt (error; WHATWG: the alt attribute must be specified), link-no-name (error; the image is the only content of a link or button and nothing gives the link a name), file-name-alt (warning; WHATWG says not to use the image's file name as alt), repeats-text (note; alt equals the link text, figure caption or parent text), image-of (note; alt starts with words like \"image of\", English only), empty-alt (note; fine when the image is decorative). Counts per state, no score. The quality of alt text is not judged. Images are not downloaded. Caps: 2 MB read, 6 s per request, 20 s per call, 5 redirects. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A page that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/alt-text-checker"},"operationId":"altTextCheckerGet","parameters":[{"name":"url","in":"query","required":true,"description":"The page to check, like https://example.com/page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AltTextResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["Image alt text"],"summary":"List the images on a page with their alt text","description":"Reads one page and lists its images in page order (at most 500): img, input type=image, area with href, and inline svg with role=\"img\" (other inline svg is counted, not checked). Each image has a resolved src (src, else data-src, data-lazy-src, data-original or the first srcset candidate), its alt text and a state: missing (no alt attribute), empty (alt=\"\", decorative), present, or hidden (aria-hidden=\"true\" on it or a parent, or role presentation or none). Flags: missing-alt (error; WHATWG: the alt attribute must be specified), link-no-name (error; the image is the only content of a link or button and nothing gives the link a name), file-name-alt (warning; WHATWG says not to use the image's file name as alt), repeats-text (note; alt equals the link text, figure caption or parent text), image-of (note; alt starts with words like \"image of\", English only), empty-alt (note; fine when the image is decorative). Counts per state, no score. The quality of alt text is not judged. Images are not downloaded. Caps: 2 MB read, 6 s per request, 20 s per call, 5 redirects. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A page that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/alt-text-checker"},"operationId":"altTextCheckerPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AltTextRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AltTextResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/http-header-checker":{"get":{"tags":["HTTP headers"],"summary":"List every response header of a URL, hop by hop","description":"Sends one GET per hop and follows redirects by hand (at most 5), recording each hop's status line, Location and header lines exactly as received: names keep their case and repeated headers stay separate (at most 100 lines per hop, values cut at 600 characters). The body is never read. For the final response it parses X-Robots-Tag (rules per user agent, as in Google's X-Robots-Tag spec), Link (targets, rel and hreflang, RFC 8288), Content-Type, Cache-Control, ETag, Last-Modified, Vary, Content-Encoding, Content-Length and Retry-After, and lists issues with severity error, warning or note: client-error (4xx), server-error (5xx or 429), too-many-redirects, redirect-chain (more than 1 redirect), temporary-redirect (302, 303, 307), xrt-noindex, xrt-nofollow, xrt-nosnippet (nosnippet or max-snippet:0), xrt-unavailable-after(-past), canonical-relative, canonical-other, hreflang-relative, hreflang-no-self, no-content-type, content-type-repeated, no-retry-after (429 or 503), last-modified-format (not IMF-fixdate), no-validator (no ETag or Last-Modified), vary-user-agent, encoding-unsupported. No score. Headers are as seen from our server; a CDN can answer differently by region or user agent. Caps: 6 s per request, 20 s per call. Public http(s) URLs on ports 80 and 443 only, every hop re-checked; a blocked or invalid URL returns 400. A URL that answers 4xx or 5xx returns 200 with the report. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/http-header-checker"},"operationId":"httpHeaderCheckerGet","parameters":[{"name":"url","in":"query","required":true,"description":"The URL to check, like https://example.com/page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpHeaderResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["HTTP headers"],"summary":"List every response header of a URL, hop by hop","description":"Sends one GET per hop and follows redirects by hand (at most 5), recording each hop's status line, Location and header lines exactly as received: names keep their case and repeated headers stay separate (at most 100 lines per hop, values cut at 600 characters). The body is never read. For the final response it parses X-Robots-Tag (rules per user agent, as in Google's X-Robots-Tag spec), Link (targets, rel and hreflang, RFC 8288), Content-Type, Cache-Control, ETag, Last-Modified, Vary, Content-Encoding, Content-Length and Retry-After, and lists issues with severity error, warning or note: client-error (4xx), server-error (5xx or 429), too-many-redirects, redirect-chain (more than 1 redirect), temporary-redirect (302, 303, 307), xrt-noindex, xrt-nofollow, xrt-nosnippet (nosnippet or max-snippet:0), xrt-unavailable-after(-past), canonical-relative, canonical-other, hreflang-relative, hreflang-no-self, no-content-type, content-type-repeated, no-retry-after (429 or 503), last-modified-format (not IMF-fixdate), no-validator (no ETag or Last-Modified), vary-user-agent, encoding-unsupported. No score. Headers are as seen from our server; a CDN can answer differently by region or user agent. Caps: 6 s per request, 20 s per call. Public http(s) URLs on ports 80 and 443 only, every hop re-checked; a blocked or invalid URL returns 400. A URL that answers 4xx or 5xx returns 200 with the report. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/http-header-checker"},"operationId":"httpHeaderCheckerPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpHeaderRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpHeaderResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/ai-overview-eligibility-checker":{"get":{"tags":["AI Overview eligibility"],"summary":"Check one URL against Google's stated conditions for AI Overviews and AI Mode links","description":"Google's AI features page: \"To be eligible to be shown as a supporting link in AI Overviews or AI Mode, a page must be indexed and eligible to be shown in Google Search with a snippet\" and \"There are no additional technical requirements.\" This reads one URL (redirects followed by hand, at most 5, every hop checked; headers kept as received so each X-Robots-Tag line is parsed on its own; the first 2 MB of HTML, uncompressed) and the final host's robots.txt, then returns report.checks in this order: robots (robots.txt allows Googlebot for the path; 4xx file means no rules, 5xx, 429 or no answer is unknown), status (2xx passes, a redirect to 2xx passes with a note, 204 and 4xx fail, 401, 403, 429 and 5xx are unknown because bot walls often answer tools that way), noindex (noindex or none from meta robots, meta googlebot, or an X-Robots-Tag line with no user agent or googlebot; meta tags in the body count; other crawler names are listed with ignored true), unavailable-after (a past date fails, an unreadable date is ignored), snippet (nosnippet or max-snippet:0 fail; the smallest max-snippet wins, -1 means no limit), data-nosnippet (share of visible characters in main, or body, inside span, div or section with data-nosnippet; all of it gives warn), canonical (another URL or several gives warn, never fail) and indexed (always info: only Search Console's URL Inspection can tell). Each check is { id, state (pass, fail, warn, unknown, skipped, info), reason, params, evidence (at most 10: the tag, header line, robots.txt line or status found), quotes (keys of Google quotes) }. Checks after a robots.txt block or a non-2xx answer are skipped, since Google never reads them. report.verdict: eligible, not-eligible (report.blocking names the failed checks) or cant-check (report.unknown). No score. Eligible never means included; Google says \"Indexing and serving isn't guaranteed.\" Caps: 6 s per request, 20 s per call. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/ai-overview-eligibility-checker"},"operationId":"aiOverviewEligibilityCheckerGet","parameters":[{"name":"url","in":"query","required":true,"description":"The page to check, like https://example.com/page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiOverviewEligibilityResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["AI Overview eligibility"],"summary":"Check one URL against Google's stated conditions for AI Overviews and AI Mode links","description":"Google's AI features page: \"To be eligible to be shown as a supporting link in AI Overviews or AI Mode, a page must be indexed and eligible to be shown in Google Search with a snippet\" and \"There are no additional technical requirements.\" This reads one URL (redirects followed by hand, at most 5, every hop checked; headers kept as received so each X-Robots-Tag line is parsed on its own; the first 2 MB of HTML, uncompressed) and the final host's robots.txt, then returns report.checks in this order: robots (robots.txt allows Googlebot for the path; 4xx file means no rules, 5xx, 429 or no answer is unknown), status (2xx passes, a redirect to 2xx passes with a note, 204 and 4xx fail, 401, 403, 429 and 5xx are unknown because bot walls often answer tools that way), noindex (noindex or none from meta robots, meta googlebot, or an X-Robots-Tag line with no user agent or googlebot; meta tags in the body count; other crawler names are listed with ignored true), unavailable-after (a past date fails, an unreadable date is ignored), snippet (nosnippet or max-snippet:0 fail; the smallest max-snippet wins, -1 means no limit), data-nosnippet (share of visible characters in main, or body, inside span, div or section with data-nosnippet; all of it gives warn), canonical (another URL or several gives warn, never fail) and indexed (always info: only Search Console's URL Inspection can tell). Each check is { id, state (pass, fail, warn, unknown, skipped, info), reason, params, evidence (at most 10: the tag, header line, robots.txt line or status found), quotes (keys of Google quotes) }. Checks after a robots.txt block or a non-2xx answer are skipped, since Google never reads them. report.verdict: eligible, not-eligible (report.blocking names the failed checks) or cant-check (report.unknown). No score. Eligible never means included; Google says \"Indexing and serving isn't guaranteed.\" Caps: 6 s per request, 20 s per call. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/ai-overview-eligibility-checker"},"operationId":"aiOverviewEligibilityCheckerPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiOverviewEligibilityRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiOverviewEligibilityResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/internal-link-checker":{"get":{"tags":["Internal links"],"summary":"List the internal links on one page with their anchor text","description":"Reads ONE page (it does not crawl a site) and lists its internal links in page order (at most 1000; all are counted). Internal means the same site as the URL that answered after redirects, subdomains included. Each link has its target (without the fragment), the anchor text and where it comes from (text, image alt, aria-label, title, or empty), rel values, and where it sits (main, nav, header, footer, aside, or null; a header or footer inside article, aside, main, nav or section counts as that section). Links are grouped by target. Flags, from Google's \"Link best practices for Google\" and \"Qualify your outbound links to Google\": empty-anchor (error; no text, image alt, aria-label or title), generic-anchor (warning; the whole text is one of Google's too generic examples, click here, read more, website, article, or a few short English words like it), nofollow (note; Google says to use robots.txt disallow for links within your own site), self-link (note; the link points to the page itself), mixed-anchors (note; one target linked with different anchor texts). not-crawlable (warning, at most 100 listed) covers a elements with no href but a script or router attribute, href=\"javascript:...\", href \"\" or \"#\", an invalid href, href on an element that is not a, and onclick on another element with a URL in it. Summary: internal, external, in-page (#fragment) and other (mailto, tel) link counts, unique internal targets, and internal links in main versus navigation. No score. Links are not fetched. Caps: 2 MB read, 6 s per request, 20 s per call, 5 redirects. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A page that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/internal-link-checker"},"operationId":"internalLinkCheckerGet","parameters":[{"name":"url","in":"query","required":true,"description":"The page to check, like https://example.com/page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalLinkResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["Internal links"],"summary":"List the internal links on one page with their anchor text","description":"Reads ONE page (it does not crawl a site) and lists its internal links in page order (at most 1000; all are counted). Internal means the same site as the URL that answered after redirects, subdomains included. Each link has its target (without the fragment), the anchor text and where it comes from (text, image alt, aria-label, title, or empty), rel values, and where it sits (main, nav, header, footer, aside, or null; a header or footer inside article, aside, main, nav or section counts as that section). Links are grouped by target. Flags, from Google's \"Link best practices for Google\" and \"Qualify your outbound links to Google\": empty-anchor (error; no text, image alt, aria-label or title), generic-anchor (warning; the whole text is one of Google's too generic examples, click here, read more, website, article, or a few short English words like it), nofollow (note; Google says to use robots.txt disallow for links within your own site), self-link (note; the link points to the page itself), mixed-anchors (note; one target linked with different anchor texts). not-crawlable (warning, at most 100 listed) covers a elements with no href but a script or router attribute, href=\"javascript:...\", href \"\" or \"#\", an invalid href, href on an element that is not a, and onclick on another element with a URL in it. Summary: internal, external, in-page (#fragment) and other (mailto, tel) link counts, unique internal targets, and internal links in main versus navigation. No score. Links are not fetched. Caps: 2 MB read, 6 s per request, 20 s per call, 5 redirects. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A page that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/internal-link-checker"},"operationId":"internalLinkCheckerPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalLinkRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalLinkResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/page-size-checker":{"get":{"tags":["Page size"],"summary":"Measure a URL's size against Googlebot's 2 MB limit","description":"Downloads one URL (redirects followed by hand, each hop checked) with Accept-Encoding: gzip, deflate, br, the encodings Google's crawlers advertise, and counts the body twice: transferredBytes (as sent, compressed when Content-Encoding is set) and decodedBytes (after decompression). Google's Googlebot page: \"Googlebot crawls the first 2MB of a supported file type, and the first 64MB of a PDF file\" and \"The file size limit is applied on the uncompressed data\", so the verdict uses decodedBytes. 1 MB is counted as 1,048,576 bytes (Google does not say), so the limit is 2,097,152 bytes (67,108,864 for PDF). verdict: under, borderline (over 2,000,000 bytes but not over 2,097,152, which is over the limit if 1MB means 1,000,000 bytes), over, unknown (the read stopped before the end and the size so far is under the limit), not-applicable (images and video, which Google says may have different limits; they are not downloaded). overCrawlerDefault compares with the 15MB default for Google's crawlers and fetchers. For HTML (only the first 4 MB is analysed): pastCut counts the headings, links (a with href) and visible text characters after byte 2,097,152 and gives the first heading whose tag starts after it; parts splits the bytes into inline script, JSON (JSON-LD, __NEXT_DATA__), Next.js RSC payload (self.__next_f scripts, grouped), style, inline svg, data: URIs, comments and the rest (markup and text); blocks lists the 10 biggest. Byte positions inside the HTML are counted as UTF-8. No score and no ranking claim. Caps: 16 MB read (compressed or not), 6 s for each request to answer, 20 s per call including the download, 5 redirects. JavaScript is not run and linked files (CSS, scripts, images) are not fetched. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A URL that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/page-size-checker"},"operationId":"pageSizeCheckerGet","parameters":[{"name":"url","in":"query","required":true,"description":"The page or file to measure, like https://example.com/page.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSizeResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["Page size"],"summary":"Measure a URL's size against Googlebot's 2 MB limit","description":"Downloads one URL (redirects followed by hand, each hop checked) with Accept-Encoding: gzip, deflate, br, the encodings Google's crawlers advertise, and counts the body twice: transferredBytes (as sent, compressed when Content-Encoding is set) and decodedBytes (after decompression). Google's Googlebot page: \"Googlebot crawls the first 2MB of a supported file type, and the first 64MB of a PDF file\" and \"The file size limit is applied on the uncompressed data\", so the verdict uses decodedBytes. 1 MB is counted as 1,048,576 bytes (Google does not say), so the limit is 2,097,152 bytes (67,108,864 for PDF). verdict: under, borderline (over 2,000,000 bytes but not over 2,097,152, which is over the limit if 1MB means 1,000,000 bytes), over, unknown (the read stopped before the end and the size so far is under the limit), not-applicable (images and video, which Google says may have different limits; they are not downloaded). overCrawlerDefault compares with the 15MB default for Google's crawlers and fetchers. For HTML (only the first 4 MB is analysed): pastCut counts the headings, links (a with href) and visible text characters after byte 2,097,152 and gives the first heading whose tag starts after it; parts splits the bytes into inline script, JSON (JSON-LD, __NEXT_DATA__), Next.js RSC payload (self.__next_f scripts, grouped), style, inline svg, data: URIs, comments and the rest (markup and text); blocks lists the 10 biggest. Byte positions inside the HTML are counted as UTF-8. No score and no ranking claim. Caps: 16 MB read (compressed or not), 6 s for each request to answer, 20 s per call including the download, 5 redirects. JavaScript is not run and linked files (CSS, scripts, images) are not fetched. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A URL that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/page-size-checker"},"operationId":"pageSizeCheckerPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSizeRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageSizeResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/indexnow-checker":{"get":{"tags":["IndexNow"],"summary":"Check that an IndexNow key file is live and matches the key","description":"Step 1 of the IndexNow checker. Checks the key format from the indexnow.org documentation (8 to 128 characters, only a-z, A-Z, 0-9 and dashes), then sends one GET to the key file: https://{host}/{key}.txt, or keyLocation, which must be on the same host. Redirects are not followed and a redirect fails the check. At most 4096 bytes are read, with a 6 s timeout. verdict is pass only when the file answers 200 and its body is exactly the key (one trailing line break allowed; the indexnow.org FAQ: \"The text inside must exactly match your API key\"). problem is null, redirected, not-found (404 or 410), status (any other non-200), empty, extra-content (the key plus other text), mismatch, too-big, timeout or network. folder is the path prefix the key file covers (/ for a root file); the documentation says a key file in a folder only covers URLs in that folder. Nothing is sent to IndexNow. Public hosts on ports 80 and 443 only; a blocked host, a bad key format or a keyLocation on another host returns 400. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/indexnow-checker"},"operationId":"indexNowKeyCheckGet","parameters":[{"name":"host","in":"query","required":true,"description":"The host, like www.example.com. A URL is accepted and its host is used.","schema":{"type":"string"}},{"name":"key","in":"query","required":true,"description":"Your IndexNow key, 8 to 128 characters of a-z, A-Z, 0-9 and dashes.","schema":{"type":"string"}},{"name":"keyLocation","in":"query","required":false,"description":"Optional. The key file URL when it is not at the root, on the same host.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndexNowKeyResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["IndexNow"],"summary":"Check that an IndexNow key file is live and matches the key","description":"Step 1 of the IndexNow checker. Checks the key format from the indexnow.org documentation (8 to 128 characters, only a-z, A-Z, 0-9 and dashes), then sends one GET to the key file: https://{host}/{key}.txt, or keyLocation, which must be on the same host. Redirects are not followed and a redirect fails the check. At most 4096 bytes are read, with a 6 s timeout. verdict is pass only when the file answers 200 and its body is exactly the key (one trailing line break allowed; the indexnow.org FAQ: \"The text inside must exactly match your API key\"). problem is null, redirected, not-found (404 or 410), status (any other non-200), empty, extra-content (the key plus other text), mismatch, too-big, timeout or network. folder is the path prefix the key file covers (/ for a root file); the documentation says a key file in a folder only covers URLs in that folder. Nothing is sent to IndexNow. Public hosts on ports 80 and 443 only; a blocked host, a bad key format or a keyLocation on another host returns 400. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/indexnow-checker"},"operationId":"indexNowKeyCheckPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndexNowKeyRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndexNowKeyResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/indexnow-checker/submit":{"post":{"tags":["IndexNow"],"summary":"Submit URLs to IndexNow after re-checking the key file","description":"Step 2 of the IndexNow checker. POST only. Checks urlList first: every URL must be http(s), on the host, and inside the key file's folder when keyLocation is given. Duplicates are removed, and at most 100 different URLs are sent per request (the protocol allows 10,000 per POST). Then it runs the step 1 key file check again in the same request. Only if that passes does it POST { host, key, keyLocation, urlList } to https://api.indexnow.org/indexnow, a fixed endpoint that can't be changed, with a 10 s timeout. The key file on the host proves the caller controls the site. submitted is false when the key file failed (keyCheck says why) or IndexNow did not answer (error). response.meaning is the indexnow.org documentation's row for the status code: 200 OK, 202 Accepted, 400 Bad request, 403 Forbidden, 422 Unprocessable Entity, 429 Too Many Requests, or null for a code the documentation does not list. There is no tighter limit for this route than the shared one. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/indexnow-checker"},"operationId":"indexNowSubmitPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndexNowSubmitRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndexNowSubmitResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/eeat-checker":{"get":{"tags":["E-E-A-T signals"],"summary":"List the trust signals an article shows","description":"Reads one article and lists 11 trust signals a reader or a rater can see, each found or missing with the evidence: a byline, a link from the byline to an author page, Article (or BlogPosting, NewsArticle and other Article types) JSON-LD with an author, Person JSON-LD, a published date shown on the page and in markup (JSON-LD datePublished or meta tags like article:published_time), an updated date shown and in markup (dateModified, article:modified_time), an internal link to an About page and to a Contact page (paths and link texts in several languages; mailto and tel links count as contact), and links to other sites from the article body. Each signal maps to a section of Google's Search Quality Rater Guidelines, Google's \"Creating helpful, reliable, people-first content\" page, or schema.org Article and Person. Google says E-E-A-T itself is not a specific ranking factor, so the result has a found count and no score. It then sends GET to the author, About and Contact pages found (at most 3) and reports their status without reading them. Caps: 2 MB read, 6 s per request, 20 s per call, 5 redirects. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A page that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/eeat-checker"},"operationId":"eeatCheckerGet","parameters":[{"name":"url","in":"query","required":true,"description":"The article to check, like https://example.com/blog/post.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EeatCheckerResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["E-E-A-T signals"],"summary":"List the trust signals an article shows","description":"Reads one article and lists 11 trust signals a reader or a rater can see, each found or missing with the evidence: a byline, a link from the byline to an author page, Article (or BlogPosting, NewsArticle and other Article types) JSON-LD with an author, Person JSON-LD, a published date shown on the page and in markup (JSON-LD datePublished or meta tags like article:published_time), an updated date shown and in markup (dateModified, article:modified_time), an internal link to an About page and to a Contact page (paths and link texts in several languages; mailto and tel links count as contact), and links to other sites from the article body. Each signal maps to a section of Google's Search Quality Rater Guidelines, Google's \"Creating helpful, reliable, people-first content\" page, or schema.org Article and Person. Google says E-E-A-T itself is not a specific ranking factor, so the result has a found count and no score. It then sends GET to the author, About and Contact pages found (at most 3) and reports their status without reading them. Caps: 2 MB read, 6 s per request, 20 s per call, 5 redirects. JavaScript is not run. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. A page that answers 4xx or 5xx returns 200 with status set and report null. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/eeat-checker"},"operationId":"eeatCheckerPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EeatCheckerRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EeatCheckerResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/ai-training-grounding-checker":{"get":{"tags":["AI preferences"],"summary":"Check a page for AI training and grounding preferences","description":"Fetches the page and its site's robots.txt, then resolves Bing AI Training (robots.txt __usage_ai-training group, page meta or X-Robots-Tag override), Bing AI Grounding (page level only), Google-Extended, and whether Bingbot and Googlebot may crawl the path. Only directives from Bing's and Google's October 30, 2026 posts. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400, an unreachable site 502. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/ai-training-grounding-checker"},"operationId":"aiTrainingGroundingCheckerGet","parameters":[{"name":"url","in":"query","required":true,"description":"The page to check, like https://example.com/blog/post.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiTrainingGroundingResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["AI preferences"],"summary":"Check a page for AI training and grounding preferences","description":"Fetches the page and its site's robots.txt, then resolves Bing AI Training (robots.txt __usage_ai-training group, page meta or X-Robots-Tag override), Bing AI Grounding (page level only), Google-Extended, and whether Bingbot and Googlebot may crawl the path. Only directives from Bing's and Google's October 30, 2026 posts. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400, an unreachable site 502. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/ai-training-grounding-checker"},"operationId":"aiTrainingGroundingCheckerPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiTrainingGroundingRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiTrainingGroundingResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/robots-txt-tester":{"get":{"tags":["robots.txt testing"],"summary":"Test a URL against robots.txt","description":"Fetches the site's /robots.txt (up to 5 redirects, first 500 KiB) and applies RFC 9309: the group naming the user agent (case-insensitive) or else the * group, longest matching path, Allow wins a tie, * and $ wildcards, percent-encoded comparison. A 4xx robots.txt allows everything; a 5xx or no answer blocks everything. Returns allowed, the deciding line and lines that decide nothing. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/robots-txt-tester"},"operationId":"robotsTxtTesterGet","parameters":[{"name":"url","in":"query","required":true,"description":"The page to test, like https://example.com/blog/post. Path and query are matched.","schema":{"type":"string"}},{"name":"userAgent","in":"query","required":false,"description":"robots.txt product token (letters, - and _). Default Googlebot. Presets: Googlebot, Bingbot, GPTBot, OAI-SearchBot, ChatGPT-User, ClaudeBot, Claude-SearchBot, PerplexityBot, Google-Extended, Applebot-Extended, CCBot.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RobotsTxtTesterResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["robots.txt testing"],"summary":"Test a URL against robots.txt","description":"Fetches the site's /robots.txt (up to 5 redirects, first 500 KiB) and applies RFC 9309: the group naming the user agent (case-insensitive) or else the * group, longest matching path, Allow wins a tie, * and $ wildcards, percent-encoded comparison. A 4xx robots.txt allows everything; a 5xx or no answer blocks everything. Returns allowed, the deciding line and lines that decide nothing. Public http(s) URLs on ports 80 and 443 only; a blocked or invalid URL returns 400. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/robots-txt-tester"},"operationId":"robotsTxtTesterPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RobotsTxtTesterRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RobotsTxtTesterResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/ai-crawler-access-checker":{"get":{"tags":["AI crawler access"],"summary":"Check if GPTBot, ClaudeBot, PerplexityBot and Google-Extended may crawl a site","description":"Reads the domain's homepage (head only, 512 KB cap, up to 4 redirects) and /robots.txt on the homepage's final host (up to 5 redirects, first 500 KiB). For each of GPTBot, ClaudeBot, PerplexityBot, Google-Extended: allowed or blocked for the homepage path under RFC 9309 (named group or else the * group, longest match, Allow wins a tie; a 4xx robots.txt allows everything, a 5xx or no answer blocks everything), the deciding line, and the homepage's meta robots and X-Robots-Tag rules that apply to all robots or name the bot. Google-Extended is a robots.txt token only, so it gets no page rules. Requests use an AY Rank user agent, never the bots' own, so CDN or firewall rules that only fire for the real bot are not visible. Public http(s) hosts on ports 80 and 443 only; a blocked or invalid domain returns 400. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/ai-crawler-access-checker"},"operationId":"aiCrawlerAccessCheckerGet","parameters":[{"name":"domain","in":"query","required":true,"description":"The site to check, like example.com. A full URL works too; only its host is used.","schema":{"type":"string"}}],"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiCrawlerAccessCheckerResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}},"post":{"tags":["AI crawler access"],"summary":"Check if GPTBot, ClaudeBot, PerplexityBot and Google-Extended may crawl a site","description":"Reads the domain's homepage (head only, 512 KB cap, up to 4 redirects) and /robots.txt on the homepage's final host (up to 5 redirects, first 500 KiB). For each of GPTBot, ClaudeBot, PerplexityBot, Google-Extended: allowed or blocked for the homepage path under RFC 9309 (named group or else the * group, longest match, Allow wins a tie; a 4xx robots.txt allows everything, a 5xx or no answer blocks everything), the deciding line, and the homepage's meta robots and X-Robots-Tag rules that apply to all robots or name the bot. Google-Extended is a robots.txt token only, so it gets no page rules. Requests use an AY Rank user agent, never the bots' own, so CDN or firewall rules that only fire for the real bot are not visible. Public http(s) hosts on ports 80 and 443 only; a blocked or invalid domain returns 400. Free, no key. Rate limit: 30 requests per 60 seconds per IP, shared across all /api/v1 tools.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/ai-crawler-access-checker"},"operationId":"aiCrawlerAccessCheckerPost","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiCrawlerAccessCheckerRequest"}}}},"responses":{"200":{"description":"Result","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiCrawlerAccessCheckerResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"429":{"$ref":"#/components/responses/RateLimited"}}}},"/api/v1/ai-crawler-ip-ranges":{"get":{"tags":["AI crawler IP ranges"],"operationId":"aiCrawlerIpRangesGet","summary":"Get the published IP ranges of AI crawlers, AI agents and search crawlers","description":"Returns the CIDR ranges each vendor publishes for its crawlers and AI agents, from these files only: https://openai.com/gptbot.json, https://openai.com/searchbot.json, https://openai.com/chatgpt-user.json, https://openai.com/adsbot.json, https://www.perplexity.ai/perplexitybot.json, https://www.perplexity.ai/perplexity-user.json, https://claude.com/crawling/bots.json, https://developers.google.com/static/crawling/ipranges/common-crawlers.json, https://www.bing.com/toolbox/bingbot.json, https://search.developer.apple.com/applebot.json, https://index.commoncrawl.org/ccbot.json, https://mistral.ai/mistralai-user-ips.json, https://mistral.ai/mistralai-index-ips.json, https://claude.com/.well-known/sail, https://developers.google.com/static/crawling/ipranges/user-triggered-agents.json. Most are JSON. claude.com/.well-known/sail is a SAIL file (TOML, draft-kelley-webbotauth-sail-00), and only its Claude-Agent prefixes are returned, with bare addresses as /32 or /128. Each file is fetched with a 6 s timeout, a 1 MB read cap and no redirects, and every CIDR is validated. A file that fails is replaced by a dated copy kept in the site's code, and its source field says snapshot. The response is cached for 24 hours. No parameters. Used by https://www.ayrank.com/tools/ai-crawler-log-checker, which matches log addresses in the browser.","externalDocs":{"description":"Use the tool in a browser","url":"https://www.ayrank.com/tools/ai-crawler-log-checker"},"responses":{"200":{"description":"Result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiCrawlerIpRangesResponse"}}}}}}}},"components":{"headers":{"X-RateLimit-Limit":{"description":"Requests allowed per window.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"responses":{"BadRequest":{"description":"Invalid input: unknown field, wrong type, missing required field, value too long, or bad JSON.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"RateLimited":{"description":"Rate limit hit. Wait Retry-After seconds.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"Retry-After":{"$ref":"#/components/headers/Retry-After"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"PoweredBy":{"type":"object","required":["text","url"],"properties":{"text":{"type":"string","const":"Powered by AY Rank"},"url":{"type":"string","format":"uri"}}},"Error":{"type":"object","required":["error","docs"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["invalid_input","rate_limited"]},"message":{"type":"string"}}},"docs":{"type":"string","format":"uri"}}},"LlmsTxtRequest":{"type":"object","additionalProperties":false,"required":["companyName","websiteUrl"],"properties":{"companyName":{"type":"string","description":"Company name.","maxLength":200,"minLength":1},"websiteUrl":{"type":"string","description":"Absolute http(s) URL of the site.","maxLength":500,"format":"uri"},"description":{"type":"string","description":"Two or three sentences on what the company does.","maxLength":2000},"industry":{"type":"string","description":"Industry, for example SaaS or Healthcare.","maxLength":100},"services":{"description":"Services, as an array or a comma-separated string.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string","maxLength":200},"maxItems":50}]},"keyPages":{"description":"Key page URLs, as an array or one per line.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string","maxLength":500},"maxItems":50}]},"differentiators":{"description":"What makes the company different, as an array or one per line.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string","maxLength":300},"maxItems":30}]},"contactEmail":{"type":"string","description":"Contact email.","maxLength":254},"socialLinks":{"description":"Social profile URLs, as an array or a comma-separated string.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string","maxLength":500},"maxItems":20}]}},"examples":[{"companyName":"Acme Analytics","websiteUrl":"https://acme.example","description":"Acme builds product analytics for B2B SaaS teams.","industry":"SaaS","services":["Product analytics","Session replay"]}]},"LlmsTxtResponse":{"type":"object","required":["llmsTxt","completeness","poweredBy"],"properties":{"llmsTxt":{"type":"string","description":"The llms.txt file contents."},"completeness":{"type":"object","required":["score","label"],"properties":{"score":{"type":"integer","minimum":0,"maximum":100},"label":{"type":"string","enum":["Excellent","Good","Fair","Needs work","Just getting started"]}}},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"TitleScoreRequest":{"type":"object","additionalProperties":false,"required":["title"],"properties":{"title":{"type":"string","description":"The title to score.","maxLength":300,"minLength":1}},"examples":[{"title":"How to Rank in ChatGPT: 7 Proven Steps for 2026"}]},"TitleScoreResponse":{"type":"object","required":["title","score","maxScore","grade","charCount","factors","poweredBy"],"properties":{"title":{"type":"string","description":"The trimmed title that was scored."},"score":{"type":"integer","minimum":0,"maximum":100},"maxScore":{"type":"integer","const":100},"grade":{"type":"string","enum":["Excellent","Good","Needs Work","Weak","Poor"]},"charCount":{"type":"integer","description":"Visible characters in the title."},"factors":{"type":"array","items":{"type":"object","required":["name","score","max","status","tip"],"properties":{"name":{"type":"string"},"score":{"type":"integer"},"max":{"type":"integer"},"status":{"type":"string","enum":["pass","warn","fail"]},"tip":{"type":"string"}}}},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"RobotsTxtRequest":{"type":"object","additionalProperties":false,"properties":{"block":{"description":"Crawlers to disallow, as an array or a comma-separated string. Case does not matter.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string","enum":["GPTBot","OAI-SearchBot","ChatGPT-User","ClaudeBot","PerplexityBot","Google-Extended","Applebot-Extended","Googlebot","Bingbot"]}}]},"blockedDirs":{"description":"Paths to disallow for every crawler, as an array or a comma-separated string.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string","maxLength":200},"maxItems":50}]},"sitemapUrl":{"type":"string","description":"Absolute http(s) URL of the sitemap.","maxLength":500,"format":"uri"}},"examples":[{"block":["GPTBot"],"blockedDirs":["/admin"],"sitemapUrl":"https://acme.example/sitemap.xml"}]},"RobotsTxtResponse":{"type":"object","required":["robotsTxt","crawlers","poweredBy"],"properties":{"robotsTxt":{"type":"string","description":"The robots.txt file contents."},"crawlers":{"type":"array","items":{"type":"object","required":["id","category","allowed"],"properties":{"id":{"type":"string"},"category":{"type":"string","enum":["ai","traditional"]},"allowed":{"type":"boolean"}}}},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"SitemapValidatorRequest":{"type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"type":"string","maxLength":2000,"description":"A sitemap URL, or a site root to find the sitemap through robots.txt."}},"examples":[{"url":"https://www.ayrank.com/sitemap.xml"}]},"SitemapValidatorResponse":{"type":"object","required":["input","discovery","sitemap","children","childrenListed","sample","limits","checkedAt","poweredBy"],"properties":{"input":{"type":"string"},"discovery":{"type":"object","description":"mode: sitemap (the URL was read as a sitemap), robots (found in robots.txt) or default (robots.txt had no Sitemap line, so /sitemap.xml). Also robotsUrl, robotsStatus and declared (the Sitemap lines found)."},"sitemap":{"type":"object","description":"url, finalUrl, status (null when there was no answer), redirects, error (blocked, timeout, network, too-many-redirects or null), contentType, gzip and report. report is null unless the file answered 2xx: { kind (urlset, sitemapindex or null), namespace, bytes, entries, lastmod { present, invalid, future }, extensions, issues, errors, warnings }. Each issue is { code, severity (error, warning or info), count, line, samples }. Codes: not-xml, xml-syntax, not-utf8, gzip-error, unknown-root, bad-namespace, bad-entity, unexpected-element, missing-loc, relative-loc, invalid-loc, long-loc, other-host, invalid-lastmod, too-many-entries, too-large, empty, nested-index, doctype, outside-path, future-lastmod, duplicate-loc, invalid-changefreq, invalid-priority, leading-whitespace, truncated, ignored-tags, same-lastmod."},"children":{"type":"array","description":"For a sitemap index: the child sitemaps read, same shape as sitemap. error is skipped when the time budget ran out.","items":{"type":"object"}},"childrenListed":{"type":"integer","description":"Child sitemaps the index lists."},"sample":{"type":["array","null"],"description":"URL status checks, or null when there were no URLs: { url, status (first answer), method (HEAD or GET), outcome (ok, redirect, client-error, server-error, other, rate-limited (429, not counted against the sitemap), blocked, timeout, error or skipped), redirects, finalUrl, finalStatus }. Only a plain 200 is ok.","items":{"type":"object"}},"limits":{"type":"object","description":"The caps used for this call."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"HreflangCheckerRequest":{"type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"type":"string","maxLength":2000,"description":"The page whose hreflang set to check."}},"examples":[{"url":"https://www.apple.com/"}]},"HreflangCheckerResponse":{"type":"object","required":["input","finalUrl","status","redirects","error","report","alternates","alternatesListed","limits","checkedAt","poweredBy"],"properties":{"input":{"type":"string"},"finalUrl":{"type":"string","description":"URL that answered after redirects. The set is checked against it."},"status":{"type":["integer","null"]},"redirects":{"type":"integer"},"error":{"type":["string","null"],"description":"timeout, network, too-many-redirects or null."},"truncated":{"type":"boolean","description":"The page was larger than the read cap."},"report":{"type":["object","null"],"description":"Null unless the page answered 2xx. { pageUrl, canonical, canonicalMatch (exact, trailing-slash or none), entries, entriesTotal, sources { html, header }, headEnd { reason (end-tag, body, element or eof), tag, line }, issues, errors, warnings }. Each entry is { hreflang, href, url, source (html or header), line, code { valid, xDefault, language, script, region, problem, suggestion }, self }. Each issue is { code, severity (error, warning or info), count, samples }. Codes: invalid-format, underscore, not-iso-639-1, unknown-language, region-only, withdrawn-language, unknown-script, numeric-region, reserved-region, withdrawn-region, unknown-region, missing-href, invalid-href, relative-href, missing-self, outside-head, alternate-not-200, no-return-link, alternate-canonical-mismatch, duplicate-hreflang, self-trailing-slash, missing-x-default, not-alternate, media-attribute, canonical-elsewhere, return-link-trailing-slash, alternate-redirect, alternate-unreachable, no-hreflang, language-looks-like-region, both-sources, alternates-not-checked."},"alternates":{"type":"array","description":"One per alternate URL read: { url, hreflang (values the page gives it), outcome (ok, redirect, not-200, blocked, timeout, network, too-many-redirects or skipped), status, redirects, finalUrl, finalStatus, hreflangCount, returnLink (exact, trailing-slash, none or null), returnHreflang, canonical, canonicalMatch }.","items":{"type":"object"}},"alternatesListed":{"type":"integer","description":"Alternate URLs the page lists, other than itself."},"limits":{"type":"object","description":"The caps used for this call."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"BrokenLinkRequest":{"type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"type":"string","maxLength":2000,"description":"The page whose links to check."}},"examples":[{"url":"https://www.ayrank.com/blog/ai-training-vs-ai-grounding"}]},"BrokenLinkResponse":{"type":"object","required":["input","finalUrl","status","redirects","error","report","limits","checkedAt","poweredBy"],"properties":{"input":{"type":"string"},"finalUrl":{"type":"string","description":"URL that answered after redirects. Links are resolved against it."},"status":{"type":["integer","null"]},"redirects":{"type":"integer"},"error":{"type":["string","null"],"description":"timeout, network, too-many-redirects, not-html or null."},"contentType":{"type":"string"},"truncated":{"type":"boolean","description":"The page was larger than the read cap."},"report":{"type":["object","null"],"description":"Null unless the page answered 2xx with HTML. { anchors, skipped { fragment, mailto, tel, javascript, other-scheme, invalid }, overCap, summary { one count per outcome, checked, problems }, links }. Links are sorted problems first; each is { url, text, count, internal, nofollow, outcome, status (first answer), finalStatus, finalUrl, redirects, blockedReason? }."},"limits":{"type":"object","description":"The caps used for this call."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"HeadingOutlineRequest":{"type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"type":"string","maxLength":2000,"description":"The page to check."}},"examples":[{"url":"https://www.w3.org/WAI/tutorials/page-structure/headings/"}]},"HeadingOutlineResponse":{"type":"object","required":["input","finalUrl","status","redirects","error","report","limits","checkedAt","poweredBy"],"properties":{"input":{"type":"string"},"finalUrl":{"type":"string","description":"URL that answered after redirects."},"status":{"type":["integer","null"]},"redirects":{"type":"integer"},"error":{"type":["string","null"],"description":"timeout, network, too-many-redirects, not-html or null."},"contentType":{"type":"string"},"truncated":{"type":"boolean","description":"The page was larger than the read cap."},"report":{"type":["object","null"],"description":"Null unless the page answered 2xx with HTML. { headings, total, counts { h1..h6 }, issues, title, textChars }. Each heading is { level, text, source (text, aria-label, alt or empty), images, region (main, nav, header, footer, aside or null), inHgroup, skipFrom (the level before a skip, or null) }. Each issue is { code (no-headings, no-h1, skipped-level, empty-heading, image-only-heading, multiple-h1, little-text), severity (error, warning or note), count, at (heading indexes, at most 20) }."},"limits":{"type":"object","description":"The caps used for this call."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"AltTextRequest":{"type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"type":"string","maxLength":2000,"description":"The page to check."}},"examples":[{"url":"https://www.w3.org/WAI/tutorials/images/"}]},"AltTextResponse":{"type":"object","required":["input","finalUrl","status","redirects","error","report","limits","checkedAt","poweredBy"],"properties":{"input":{"type":"string"},"finalUrl":{"type":"string","description":"URL that answered after redirects. Image addresses are resolved against it (or its base href)."},"status":{"type":["integer","null"]},"redirects":{"type":"integer"},"error":{"type":["string","null"],"description":"timeout, network, too-many-redirects, not-html or null."},"contentType":{"type":"string"},"truncated":{"type":"boolean","description":"The page was larger than the read cap."},"report":{"type":["object","null"],"description":"Null unless the page answered 2xx with HTML. { images, total, counts { missing, empty, present, hidden }, issues, svgSkipped, title }. Each image is { index, kind (img, input, area or svg), src, alt (null when missing), state (missing, empty, present or hidden), inLink, flags, severity (error, warning, note or null) }. Flag codes: missing-alt, link-no-name, file-name-alt, repeats-text, image-of, empty-alt. Each issue is { code (a flag code or no-images), severity, count, at (image indexes, at most 20) }. There is no score field."},"limits":{"type":"object","description":"The caps used for this call."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"HttpHeaderRequest":{"type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"type":"string","maxLength":2000,"description":"The URL to check."}},"examples":[{"url":"http://example.com/"}]},"HttpHeaderResponse":{"type":"object","required":["input","finalUrl","status","redirects","error","report","limits","checkedAt","poweredBy"],"properties":{"input":{"type":"string"},"finalUrl":{"type":"string","description":"URL of the last response read."},"status":{"type":["integer","null"],"description":"Status of the last response read."},"redirects":{"type":"integer"},"error":{"type":["string","null"],"description":"timeout, network, too-many-redirects or null. The hops read before the error are still in report."},"report":{"type":["object","null"],"description":"Null only when no response arrived. { hops, redirects, final, topics, issues }. Each hop is { index, url, status, statusText, meaning (ok, no-content, redirect-permanent, redirect-temporary, not-modified, client-error, server-error or other), location (resolved), headers, omitted }. Each header is { name (case as received), value, cut, topic (x-robots-tag, link, content-type, cache-control, etag, last-modified, vary, content-encoding, content-length, location, retry-after or null) }. final is the last hop plus count, robots [{ bot (null for all crawlers), rule, value, known }], links [{ raw, url, absolute, rel, hreflang }], contentType, cacheControl, etag, lastModified, vary, contentEncoding, contentLength, retryAfter. Each issue is { code, severity (error, warning or note), detail }. There is no score field."},"limits":{"type":"object","description":"The caps used for this call."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"AiOverviewEligibilityRequest":{"type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"type":"string","maxLength":2000,"description":"The page to check."}},"examples":[{"url":"https://www.ayrank.com/"}]},"AiOverviewEligibilityResponse":{"type":"object","required":["input","finalUrl","status","redirects","hops","error","contentType","xRobotsTag","htmlBytes","htmlCut","robots","report","limits","checkedAt","poweredBy"],"properties":{"input":{"type":"string"},"finalUrl":{"type":"string","description":"URL of the last answer, after redirects."},"status":{"type":["integer","null"],"description":"Status of the last answer, or null when none arrived."},"redirects":{"type":"integer"},"hops":{"type":"array","description":"Every answer on the way: { url, status }."},"error":{"type":["string","null"],"description":"timeout, network, too-many-redirects or null."},"contentType":{"type":"string"},"xRobotsTag":{"type":"array","items":{"type":"string"},"description":"X-Robots-Tag lines of the last answer, one per line as received."},"htmlBytes":{"type":"integer","description":"Uncompressed HTML bytes read."},"htmlCut":{"type":"boolean","description":"True when the HTML was longer than the read cap."},"robots":{"type":["object","null"],"description":"{ url, status, tooManyRedirects, text } for the final host's robots.txt."},"report":{"type":"object","description":"{ verdict (eligible, not-eligible, cant-check), blocking (failed check ids), unknown (unknown check ids), checks [{ id, state, reason, params, evidence [{ kind (robots, status, meta, header, link, text), text, line, ignored }], quotes }], text { scope (main, body or null), chars, nosnippetChars }, isHtml }. There is no score field."},"limits":{"type":"object","description":"The caps used for this call."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"IndexNowKeyRequest":{"type":"object","required":["host","key"],"additionalProperties":false,"properties":{"host":{"type":"string","maxLength":300,"description":"The host, like www.example.com."},"key":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[A-Za-z0-9-]+$"},"keyLocation":{"type":"string","maxLength":2000,"description":"Optional key file URL on the same host."}},"examples":[{"host":"www.ayrank.com","key":"74c4bc53dea7f709bbb8461fc6b955d6"}]},"IndexNowKeyResponse":{"type":"object","required":["host","key","keyFileUrl","keyLocation","folder","status","contentType","location","bodyPreview","verdict","problem","checkedAt","poweredBy"],"properties":{"host":{"type":"string"},"key":{"type":"string"},"keyFileUrl":{"type":"string","description":"The URL read."},"keyLocation":{"type":"boolean","description":"True when keyLocation was given."},"folder":{"type":"string","description":"Path prefix the key file covers."},"status":{"type":["integer","null"],"description":"Null when no answer arrived."},"contentType":{"type":"string"},"location":{"type":["string","null"],"description":"Location header of a redirect."},"bodyPreview":{"type":"string","description":"The first 200 characters of the body (200 answers only)."},"verdict":{"type":"string","enum":["pass","fail"]},"problem":{"type":["string","null"],"enum":["redirected","not-found","status","empty","extra-content","mismatch","too-big","timeout","network",null]},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"IndexNowSubmitRequest":{"type":"object","required":["host","key","urlList"],"additionalProperties":false,"properties":{"host":{"type":"string","maxLength":300},"key":{"type":"string","minLength":8,"maxLength":128,"pattern":"^[A-Za-z0-9-]+$"},"keyLocation":{"type":"string","maxLength":2000},"urlList":{"description":"URLs on the host, as an array or one string with one URL per line. At most 100 after duplicates are removed.","oneOf":[{"type":"string"},{"type":"array","items":{"type":"string","maxLength":2000},"maxItems":500}]}},"examples":[{"host":"www.example.com","key":"your-indexnow-key","urlList":["https://www.example.com/new-page"]}]},"IndexNowSubmitResponse":{"type":"object","required":["keyCheck","submitted","endpoint","request","response","error","checkedAt","poweredBy"],"properties":{"keyCheck":{"$ref":"#/components/schemas/IndexNowKeyResponse"},"submitted":{"type":"boolean","description":"True when IndexNow answered."},"endpoint":{"type":"string","const":"https://api.indexnow.org/indexnow"},"request":{"type":["object","null"],"description":"The JSON body sent: { host, key, keyLocation, urlList }. Null when the key file failed."},"response":{"type":["object","null"],"description":"IndexNow's answer: { status, statusText, meaning ({ response, reason } from the documentation's table, or null), retryAfter, bodyPreview (first 500 characters) }."},"error":{"type":["string","null"],"description":"timeout or network when IndexNow did not answer."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"InternalLinkRequest":{"type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"type":"string","maxLength":2000,"description":"The page to check."}},"examples":[{"url":"https://developers.google.com/search/docs/crawling-indexing/links-crawlable"}]},"InternalLinkResponse":{"type":"object","required":["input","finalUrl","status","redirects","error","report","limits","checkedAt","poweredBy"],"properties":{"input":{"type":"string"},"finalUrl":{"type":"string","description":"URL that answered after redirects. It decides what is internal, and links are resolved against it (or its base href)."},"status":{"type":["integer","null"]},"redirects":{"type":"integer"},"error":{"type":["string","null"],"description":"timeout, network, too-many-redirects, not-html or null."},"contentType":{"type":"string"},"truncated":{"type":"boolean","description":"The page was larger than the read cap."},"report":{"type":["object","null"],"description":"Null unless the page answered 2xx with HTML. { siteUrl, siteFrom, links, total, targets, uncrawlable, uncrawlableTotal, summary, issues, title, textChars }. Each link is { index, url, fragment, text, source (text, alt, aria-label, title or empty), rel, region (main, nav, header, footer, aside or null), flags (empty-anchor, generic-anchor, nofollow, self-link), severity (error, warning, note or null) }. Each target is { url, count, anchors [{ text, source, count }], rows, mixed, severity }. Each uncrawlable item is { index, reason (no-href, javascript-href, no-destination, invalid-href, href-not-a, script-click), code, text, region }. summary is { anchors, internal, external, inPage, other, uncrawlable, uniqueInternal, main, navigation, unmarked, nofollowInternal }. Each issue is { code (empty-anchor, generic-anchor, not-crawlable, nofollow, self-link, mixed-anchors, no-internal-links, little-text), severity, count, at (link or uncrawlable indexes, at most 20) }. There is no score field."},"limits":{"type":"object","description":"The caps used for this call."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"PageSizeRequest":{"type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"type":"string","maxLength":2000,"description":"The page or file to measure."}},"examples":[{"url":"https://www.ayrank.com/"}]},"PageSizeResponse":{"type":"object","required":["input","finalUrl","status","redirects","error","report","limits","checkedAt","poweredBy"],"properties":{"input":{"type":"string"},"finalUrl":{"type":"string","description":"URL that answered after redirects."},"status":{"type":["integer","null"]},"redirects":{"type":"integer"},"error":{"type":["string","null"],"description":"timeout, network, too-many-redirects or null. A read that stops during the download is reported in report.stopped instead."},"contentType":{"type":"string"},"contentEncoding":{"type":["string","null"],"description":"Content-Encoding as sent, like br or gzip."},"contentLength":{"type":["integer","null"],"description":"Content-Length as sent, if any."},"report":{"type":["object","null"],"description":"Null unless the final answer was 2xx. { kind (html, pdf, image, video, other), limit, limitDecimal, transferredBytes, decodedBytes, exact (whole body read), stopped (cap, timeout, network, decode or null), encoding, ratio, verdict (under, borderline, over, unknown, not-applicable), percent (decodedBytes / limit * 100), headroom (limit minus decodedBytes; negative when over), overCrawlerDefault, transferredOver, html }. html is null unless kind is html: { analysedBytes, partial, total { headings, links, textChars }, pastCut (null unless over 2,097,152 bytes) { bytes, headings, links, textChars, firstHeading { level, text, start } or null, partial, analysedBytes }, parts { script, json, rsc, style, svg, data-uri, comment, rest }, blocks [{ kind, label, bytes, share, start, count }] }. There is no score field."},"limits":{"type":"object","description":"The caps used for this call."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"EeatCheckerRequest":{"type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"type":"string","maxLength":2000,"description":"The article to check."}},"examples":[{"url":"https://developers.google.com/search/blog/2022/12/google-raters-guidelines-e-e-a-t"}]},"EeatCheckerResponse":{"type":"object","required":["input","finalUrl","status","redirects","error","report","linkChecks","limits","checkedAt","poweredBy"],"properties":{"input":{"type":"string"},"finalUrl":{"type":"string","description":"URL that answered after redirects. Links are resolved against it."},"status":{"type":["integer","null"]},"redirects":{"type":"integer"},"error":{"type":["string","null"],"description":"timeout, network, too-many-redirects, not-html or null."},"contentType":{"type":"string"},"truncated":{"type":"boolean","description":"The page was larger than the read cap."},"report":{"type":["object","null"],"description":"Null unless the page answered 2xx with HTML. { signals, found, total, page { title, h1, lang, textChars }, littleText, jsonLd { blocks, invalid, types }, outbound { total, hosts, nofollow, sponsored, ugc, scope (article, main or body) }, linksToCheck }. Each signal is { id, group (who, when, site or sources), found, evidence, evidenceTotal, notes }. Signal ids: byline, author_link, article_schema, person_schema, published_visible, published_markup, updated_visible, updated_markup, about_link, contact_link, outbound_links. Each evidence item is { kind (text, link, json-ld, meta or time), value, url, where }. Note codes: article-no-author, author-organization, author-schema-url-only, person-no-url-or-sameas, nofollow, sponsored-ugc, scope-article, scope-main, scope-body, mailto-tel, no-article-type. There is no score field."},"linkChecks":{"type":"array","description":"One per linked page checked: { role (author, about or contact), url, outcome (ok, redirect, not-200, blocked, timeout, network, too-many-redirects or skipped), status, redirects, finalUrl, finalStatus }.","items":{"type":"object"}},"limits":{"type":"object","description":"The caps used for this call."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"AiTrainingGroundingRequest":{"type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"type":"string","maxLength":2000,"description":"The page to check."}}},"AiTrainingGroundingResponse":{"type":"object","required":["url","finalUrl","page","robots","report","checkedAt","poweredBy"],"properties":{"url":{"type":"string"},"finalUrl":{"type":"string","description":"The URL after redirects. Its robots.txt is the one read."},"page":{"type":"object","description":"HTTP status, content type, X-Robots-Tag values of the page, and readable (false for a non-2xx answer)."},"robots":{"type":"object","description":"robots.txt URL, HTTP status, whether it was found and whether it could be read."},"report":{"type":"object","description":"bing.training and bing.grounding: { value, source } where value is allow, disallow, disallowextended (grounding only), conflict or unknown, and source is page, robots, default, robots-unavailable or page-unavailable (the page answered with an error or a bot check). bing.crawl and google.crawl: allowed, blocked or unknown. google.googleExtended: allowed, disallowed, not-specified or unknown. google.sharedToken is always not-published."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"AiCrawlerIpRangesResponse":{"type":"object","required":["generatedAt","snapshotDate","lists","poweredBy"],"properties":{"generatedAt":{"type":"string","format":"date-time","description":"When this response was built."},"snapshotDate":{"type":"string","description":"Date of the saved copy used when a vendor file fails."},"lists":{"type":"array","items":{"type":"object","required":["id","vendor","url","source","fetchedAt","creationTime","prefixes","error"],"properties":{"id":{"type":"string","enum":["openai-gptbot","openai-searchbot","openai-chatgpt-user","openai-adsbot","perplexity-bot","perplexity-user","anthropic-bots","google-common-crawlers","bing-bingbot","apple-applebot","commoncrawl-ccbot","mistral-user","mistral-index","anthropic-claude-agent","google-user-triggered-agents"]},"vendor":{"type":"string"},"url":{"type":"string","format":"uri","description":"The vendor file."},"source":{"type":"string","enum":["live","snapshot","missing"],"description":"live: fetched from the vendor for this response. snapshot: the dated copy, because the fetch failed."},"fetchedAt":{"type":["string","null"],"description":"Fetch time for live, the date that list was saved for snapshot."},"creationTime":{"type":["string","null"],"description":"The creationTime the vendor wrote in the file (for a SAIL file, its modified date)."},"prefixes":{"type":"array","items":{"type":"string"},"description":"IPv4 and IPv6 CIDR ranges."},"invalidDropped":{"type":"integer","description":"Entries dropped because they were not valid CIDRs."},"error":{"type":["string","null"],"description":"Why the live fetch failed, for snapshot entries."}}}},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"AiCrawlerAccessCheckerRequest":{"type":"object","required":["domain"],"additionalProperties":false,"properties":{"domain":{"type":"string","maxLength":300,"description":"The site to check, like example.com."}},"examples":[{"domain":"example.com"}]},"AiCrawlerAccessCheckerResponse":{"type":"object","required":["domain","homepage","robots","path","report","robotsTxt","checkedAt","poweredBy"],"properties":{"domain":{"type":"string"},"homepage":{"type":"object","description":"url, finalUrl after redirects (null when it did not answer), status, readable (2xx) and xRobotsTag lines."},"robots":{"type":"object","description":"url, finalUrl, status (null when the site did not answer), redirects, tooManyRedirects and found."},"path":{"type":"string","description":"The homepage path robots.txt rules were matched against."},"report":{"type":"object","description":"bots: one entry per bot with token, vendor, kind (training, search or gemini-control), doc { title, url }, robotsOnly, allowed, reason (rule, no-rule-matched, no-group, empty-file, file-unavailable, file-unreachable or too-many-redirects), line { line, text } of the deciding line, via (named or wildcard), agentLines, pageRules [{ source, scope, rule, value, raw }] and pageStops (a noindex, none or nofollow rule applies). Also allowedCount, blockedCount, robotsIsHtml, truncated and groupCount."},"robotsTxt":{"type":["string","null"],"description":"The robots.txt body read (2xx only), up to 500 KiB."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}},"RobotsTxtTesterRequest":{"type":"object","required":["url"],"additionalProperties":false,"properties":{"url":{"type":"string","maxLength":2000,"description":"The page to test."},"userAgent":{"type":"string","maxLength":64,"pattern":"^[A-Za-z_-]+$","description":"robots.txt product token. Default Googlebot."}},"examples":[{"url":"https://example.com/blog/post","userAgent":"GPTBot"}]},"RobotsTxtTesterResponse":{"type":"object","required":["url","path","userAgent","allowed","robots","result","robotsTxt","checkedAt","poweredBy"],"properties":{"url":{"type":"string"},"path":{"type":"string","description":"Path plus query string, the part robots.txt rules match."},"userAgent":{"type":"string"},"allowed":{"type":"boolean"},"robots":{"type":"object","description":"robots.txt URL, final URL after redirects, HTTP status (null when the site did not answer), redirects followed, and tooManyRedirects."},"result":{"type":"object","description":"decision: { allowed, reason, rule, via, agentLines }. reason is rule, no-rule-matched, no-group, empty-file, robots-txt-path, file-unavailable (4xx), file-unreachable (5xx or no answer) or too-many-redirects. rule is { allow, pattern, line, text } of the deciding line. via is named or wildcard. Also ignored (lines that decide nothing, with line numbers), sitemaps, bytes, truncated (file over 500 KiB) and groupCount."},"robotsTxt":{"type":["string","null"],"description":"The robots.txt body read (2xx only), up to 500 KiB."},"checkedAt":{"type":"string","format":"date-time"},"poweredBy":{"$ref":"#/components/schemas/PoweredBy"}}}}}}