Website Auditor

API Documentation

Trigger website audits programmatically with our REST API. Built for IT departments at small-to-medium businesses and solo entrepreneurs.

Get an API key with 5 automated audits per day through the admin portal. Sign in with Google to create and manage your keys.

Admin Portal →

Authentication

All API requests require an API key in the X-API-Key header. Keys start with wa_.

Getting Your API Key

  1. Visit /admin_portal and sign in with Google
  2. Create a new API key — the plaintext key is shown once, copy it immediately
  3. Send the key in the X-API-Key header on every request
  4. Revoke or rotate keys any time from the portal

Example Request

curl "https://api.website-auditor.io/api/audit?businessUrl=example.com&businessName=Example+Inc&businessCity=Seattle" \ -H "X-API-Key: wa_your_api_key_here"

Rate Limits

5 requests per API key per day. Rate limit headers are included in every response:

X-RateLimit-Limit: 5 X-RateLimit-Remaining: 3 X-RateLimit-Reset: 2026-03-31T23:59:59.999Z

Endpoints

GET
/api/audit
Trigger a website audit and return the results
⌄

Request

Headers:

X-API-Key: wa_your_api_key_here

Query Parameters:

Parameter Type Description
businessUrl string Website URL to audit required
e.g. example.com or https://example.com
businessName string Name of the business required
e.g. Example Inc
businessCity string City for local search analysis required
e.g. Seattle, WA

Example URL:

GET /api/audit?businessUrl=example.com&businessName=Example+Inc&businessCity=Seattle

Responses

200 OK — Audit completed:

{ "success": true, "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "timestamp": "2026-03-31T12:00:00.000Z", "duration_ms": 15230, "audit": { "format": "html_report", "report_url": "https://website-auditor.io/report/abc123", "status": "completed", "note": "The audit completed successfully. The full HTML report is available at the report_url." } }

400 Validation Error:

{ "success": false, "error": "Validation failed", "details": [ "businessUrl is required. Provide the website URL to audit.", "businessCity is required. Provide the city for local search analysis." ] }

401 Invalid API Key:

{ "success": false, "error": "Invalid API key. Check that your key is correct." }

429 Rate Limited:

{ "success": false, "error": "Rate limit exceeded. You can make 5 requests per day.", "rate_limit": { "limit": 5, "remaining": 0, "resets_at": "2026-03-31T23:59:59.999Z" } }

502 Upstream Error:

{ "success": false, "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "The audit service returned an error. Please try again later.", "upstream_status": 500 }

HTTP Status Codes

The API uses standard HTTP status codes to indicate the result of your request.

200 OK
Audit completed successfully
400 Bad Request
Missing or invalid query parameters
401 Unauthorized
Missing or invalid API key
429 Too Many Requests
Rate limit exceeded (5 requests per key per day)
502 Bad Gateway
Upstream audit service error; try again later

Admin Portal

Visit /admin_portal to manage your API keys. Sign in with Google.

Portal Features

  • Create keys — plaintext shown once at creation, copy immediately
  • View keys — creation date and last-used timestamp for each key
  • Revoke keys — instantly disable a key that should no longer work
  • Rotate keys — revokes the old key and generates a new one
  • Usage stats — requests today and total requests per key

Bug Report a Bug

We'll capture page details automatically

0/1000
Done
Report submitted!
Thank you for helping us improve.