New AI Search Toolkit: Track your AI brand visibility effortlessly!
API Description

Website audit

IMPORTANT: This is the Data API (api.seranking.com). For Project API (api4.seranking.com, included in Business/Enterprise plans), see Project API Docs. API keys are not interchangeable—use the correct one to avoid authentication errors.

If you’re seeing auth errors or need help, contact [email protected] for support.

Important Note: This API is not yet available. We’re in the final stages of restructuring and integrating our Website Audit functionality into the unified SE Ranking Data API under the v1 namespace. This means the endpoints described below are planned but not live yet. Stay tuned for the official launch!

To get notified the moment it’s ready (including early access, full documentation, and updates), join our waitlist by filling out this quick Google Form:

Sign Up for Website Audit API Waitlist

We’ll email you with all the details as soon as it’s live—no spam, just API goodness.

Overview

The Website Audit API allows you to programmatically run website audits, retrieve results, and manage audit tasks. It’s designed for seamless integration into your SEO tools, reporting dashboards, or custom workflows. Key benefits include:

  • Unified Access: All endpoints under https://api.seranking.com/v1/website-audit/.
  • RESTful Design: Resource-oriented naming with standard HTTP methods (GET, POST, PATCH, DELETE).
  • Usage-Based Pricing: Credits consumed based on pages crawled. No flat fees for API calls themselves.
  • Target Use Cases:
    • Automating multi-client SEO reporting for agencies.
    • Embedding audit data into SaaS products.

API Credit Costs

Audits consume credits based on the crawl type and number of pages successfully crawled. Costs are calculated upon completion.

Crawl TypeCredit Cost per Page
Standard Crawl2 credits
Advanced Crawl (with JavaScript rendering)20 credits

Note:

  • Enabling JavaScript (enable_javascript: true) incurs additional charges. Default is false.
  • GET requests for status/checks, listing resources, PATCH, and DELETE do not consume credits.
  • Scheduling: Initially limited to manual triggers (no automated schedules in v1 launch).

Key Endpoints

Here’s a preview of the restructured endpoints. Full request/response schemas, parameters, and examples will be available in the documentation upon release.

Action-Triggering Endpoints (Consume Credits)

These initiate new audits and will deduct credits based on pages crawled.

ActionMethodEndpointDescription
Run New AuditPOST/v1/website-audit/auditsStart a new website audit. Example body: { "start_url": "https://example.com", "limit": 300000, "enable_javascript": false }
Restart AuditPOST/v1/website-audit/audits/recheckRestart an existing audit (requires audit_id query param).
  • Rate Limits: 1 request per second (RPS).
  • Max Pages: Depends on account type (e.g., Trial: 100 pages; Data API: up to 300,000 pages).

Guiding Principles

  • Namespace: All under /v1/.
  • Identifiers: Use query params (e.g., /v1/website-audit/audits?audit_id=12345).

Frequently Asked Questions

  • IP Whitelisting: If you encounter errors requiring IP whitelisting, check our documentation for solutions (e.g., identifying and resolving common issues).
  • Notifications: Use the Google Form above to stay updated.
  • Timeline: Expected soon—join the waitlist for exact details.

Questions? Contact support at [email protected].

Stats Insight: On average, audits crawl about 371 pages per request—plan your credit usage accordingly!