SEO Audit API Documentation

Make your first API call in seconds. Send a GET request with the target URL:

curl "https://ai-seo-audit-seven.vercel.app/api/v1/audit?url=https://example.com"

No authentication needed. You will receive a JSON response with a full SEO audit of the specified page.

The audit endpoint accepts a target URL as a query parameter and returns a JSON object containing the complete SEO analysis. The response typically completes within 5–15 seconds depending on the target page size.

All parameters are passed as query string parameters on the GET request.

The API returns a JSON object with the following top-level structure:

{
  "success": true,
  "url": "https://example.com",
  "audit": {
    "meta": {
      "title": "Example Domain",
      "titleLength": 13,
      "description": "This domain is for use in...",
      "descriptionLength": 36,
      "h1": ["Example Domain"],
      "canonical": "https://example.com",
      "ogTitle": "Example Domain",
      "ogDescription": "This domain is for use in...",
      "ogImage": "https://example.com/image.png"
    },
    "performance": {
      "lcp": 1.2,
      "inp": 85,
      "cls": 0.05,
      "fcp": 0.8,
      "ttfb": 120,
      "score": 92
    },
    "schema": {
      "valid": true,
      "types": ["WebPage", "Organization"],
      "errors": [],
      "warnings": []
    },
    "content": {
      "score": 78,
      "wordCount": 1250,
      "readabilityScore": "A",
      "keywordDensity": 2.1
    },
    "links": {
      "internal": 12,
      "external": 3,
      "broken": 0
    },
    "images": {
      "total": 5,
      "missingAlt": 0
    },
    "overallScore": 85
  }
}

The API enforces a rate limit of 10 requests per minute per IP address. This is generous enough for most monitoring, reporting, and development use cases.

If you need higher rate limits for production workloads or enterprise applications, reach out to our team for a custom plan.

Use the API from any language that supports HTTP requests. Here are examples in JavaScript and Python:

JavaScript (fetch)

async function auditUrl(url) {
  const response = await fetch(
    `https://ai-seo-audit-seven.vercel.app/api/v1/audit?url=${encodeURIComponent(url)}`
  );

  if (!response.ok) {
    throw new Error(`Audit failed: ${response.status}`);
  }

  const data = await response.json();
  console.log("Overall Score:", data.audit.overallScore);
  console.log("Meta Title:", data.audit.meta.title);
  console.log("LCP:", data.audit.performance.lcp + "s");

  return data;
}

auditUrl("https://example.com");

Python (requests)

import requests
from urllib.parse import urlencode

def audit_url(url):
    params = {"url": url}
    response = requests.get(
        "https://ai-seo-audit-seven.vercel.app/api/v1/audit",
        params=params
    )
    response.raise_for_status()
    data = response.json()

    print(f"Overall Score: {data['audit']['overallScore']}")
    print(f"Meta Title: {data['audit']['meta']['title']}")
    print(f"LCP: {data['audit']['performance']['lcp']}s")

    return data

audit_url("https://example.com")

cURL

# Basic GET request
curl "https://ai-seo-audit-seven.vercel.app/api/v1/audit?url=https://example.com"

# With text format
curl "https://ai-seo-audit-seven.vercel.app/api/v1/audit?url=https://example.com&format=text"

# Pretty-print JSON output
curl -s "https://ai-seo-audit-seven.vercel.app/api/v1/audit?url=https://example.com" | jq .