Skip to content
SEO Optimizer is live, Audit on page SEO and AI-search readiness. Try it free
Scanverra
Sign in
QuickstartGet started

Get started

Quickstart

Create an API key, run a Website Audit, and read the result. Five minutes, no SDK needed.

Run your first scan

  1. 1

    Create an API key

    Open API Keys and create a key. Every plan includes one; Free keys share the free monthly scan limits.
  2. 2

    Keep it in an environment variable

    The key starts with sk_live_. Keep it out of your code and your repository.
    shell
    export SCANVERRA_API_KEY="sk_live_..."
  3. 3

    Send a request

    The Website Audit waits for the finished report, so the response is the result. It takes 30 to 90 seconds.
    curl -X POST https://www.scanverra.com/api/audit \
  -H "X-API-Key: $SCANVERRA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com"}'
  4. 4

    Read the response

    A few fields to start with:
    • performanceScore0 to 100, along with seoScore, accessibilityScore and bestPracticesScore.
    • issuesWhat's wrong, each with a severity and a description.
    • fixesFixes written for the stack Scanverra detected.
    • reportIdOpen the same report in the app at /report/:reportId.
Send the key as X-API-Key: sk_live_... or Authorization: Bearer. Treat it like a password: anyone with it can run scans on your plan. Revoke a leaked key on the API Keys page.

Where to go next