API Documentation

Integrate CiteCrawl GEO audits into your applications, CI/CD pipelines, and agency workflows.

The CiteCrawl API is available to Pro plan subscribers ($100/month, up to 50 audits/month). API access enables programmatic audit submission and result retrieval.

Authentication

All API requests require a valid session token obtained through Supabase Auth. Pro plan subscribers authenticate with their existing CiteCrawl credentials.

# Authenticate and get session token

POST /api/auth/session

Content-Type: application/json

{"email": "you@company.com", "password": "..."}

Submit an Audit

Submit a URL for GEO audit. Pro subscribers with active subscriptions will have the audit created directly without payment. The audit processes asynchronously and results are delivered via email and dashboard.

# Submit audit

POST /api/audit/submit

Content-Type: application/json

Authorization: Bearer <session_token>

{"url": "https://example.com", "paymentType": "pro"}

# Response (Pro subscriber)

{"success": true, "auditId": "uuid-...", "redirect": "/dashboard"}

Retrieve Audit Results

View audit status, scores, and category breakdowns for any audit belonging to the authenticated user.

# Get audit by ID

GET /api/audit/{id}

Authorization: Bearer <session_token>

# Response

{"id": "...", "url": "...", "status": "complete",

"overall_score": 77, "score_breakdown": {...}}

Download Report

Get a presigned URL to download the PDF report for a completed audit.

# Download PDF report

GET /api/reports/{audit_id}

Authorization: Bearer <session_token>

# Response: redirects to S3 presigned URL

Rate Limits

Pro plan subscribers are limited to 50 audit submissions per calendar month. The quota resets on the 1st of each month at midnight UTC.

Plan	Monthly Limit	API Access
Single Audit	1 per purchase	No
Quarterly	1 per quarter	No
Pro	50 per month	Yes

Need Help?

For API support, integration guidance, or to discuss enterprise requirements, contact our team.