SEO Audit API – CrawlRaven Developer Documentation | CrawlRaven

The SEO Audit API for developers and platforms

Programmatically run SEO audits, retrieve issues, and download reports with the CrawlRaven REST API. Available on Enterprise plans and above.

API capabilities

Fast JSON responses

All endpoints return structured JSON with consistent error codes and pagination.

API key authentication

Secure API key authentication with per-key rate limits and scope controls.

Webhooks

Receive real-time notifications when audits complete via HTTP webhooks.

SDKs and examples

Official Node.js and Python SDKs, plus code examples in cURL, PHP, and Ruby.

Quick start

Authentication

Include your API key in the Authorization header of every request:

curl https://api.crawlraven.com/v1/audits \
  -H "Authorization: Bearer YOUR_API_KEY"

Start an audit

Submit a URL to begin a new SEO audit. The response returns an audit_id you can use to poll for results:

curl -X POST https://api.crawlraven.com/v1/audits \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "depth": 3,
    "max_pages": 500
  }'

{
  "audit_id": "aud_01HXYZ1234567890",
  "status": "running",
  "url": "https://example.com",
  "created_at": "2025-01-15T10:30:00Z",
  "estimated_completion": "2025-01-15T10:35:00Z"
}

Retrieve results

Poll the audit endpoint until status is complete, then fetch the issues:

curl https://api.crawlraven.com/v1/audits/aud_01HXYZ1234567890/issues \
  -H "Authorization: Bearer YOUR_API_KEY"

API endpoints

Method	Endpoint	Description
POST	/v1/audits	Start a new SEO audit for a given URL
GET	/v1/audits/{audit_id}	Retrieve the status and results of an audit
GET	/v1/audits	List all audits for your account
DELETE	/v1/audits/{audit_id}	Delete an audit and its associated data
GET	/v1/audits/{audit_id}/issues	Get a paginated list of all issues found in an audit
GET	/v1/audits/{audit_id}/report	Download a PDF report for a completed audit
GET	/v1/projects	List all projects in your account
POST	/v1/projects	Create a new project

What you can build with the SEO API

Embed SEO audits inside your own SaaS product
Automate monthly client audit reports
Build custom dashboards pulling CrawlRaven data
Trigger audits on every deploy in your CI/CD pipeline
Create white-label audit portals for your agency clients
Integrate SEO health scores into your CRM or project management tool

Rate limits

Plan	API requests / minute	Concurrent audits
Starter	Not available	—
Agency	Not available	—
Enterprise	1,000 req/min	10
Enterprise Plus	10,000 req/min	50

Free 14-day trial

Ready to integrate the SEO Audit API?

API access is available on Enterprise plans. Contact our sales team to get started.