API Documentation

Integrate WebSEOspy into your workflow

Endpoints

Audit Endpoint

POST /api/audit 
{
  "url": "example.com"
}

Parameters

Parameter Type Description
url string Website URL to audit (with or without protocol)

Response Schema

The API returns a comprehensive JSON object containing all audit results.

Top Level Fields

  • url - Final URL after redirects
  • originalUrl - Submitted URL
  • status - HTTP status and redirect chain
  • score - Overall SEO score (0-100)
  • meta - Title and description analysis
  • headers - H1-H6 structure analysis
  • images - Image SEO audit
  • keywords - Density analysis
  • technical - SSL, mobile, canonical, links
  • performance - Speed metrics
  • assets - JS/CSS size analysis
  • schema - Structured data detection
  • linkJuice - Internal/external link analysis
  • priorityActions - Prioritized recommendations

Scoring Algorithm

Scores start at 100 points and deduct for issues:

-20 Missing title tag
-15 Missing H1 or Multiple H1s
-15 No HTTPS
-15 Title length issues
-20 >20% images missing alt
-10 Missing viewport