Documentação da API de Auditoria de SEO

Faça sua primeira chamada de API em segundos. Envie uma solicitação GET com a URL de destino:

curl "https://www.auditme.dev/api/v1/audit?url=https://example.com"

Nenhuma autenticação é necessária. Você receberá uma resposta JSON com uma auditoria completa de SEO da página especificada.

O endpoint de auditoria aceita uma URL de destino como parâmetro de consulta e retorna um objeto JSON contendo a análise completa de SEO. A resposta normalmente é concluída em 5–15 segundos, dependendo do tamanho da página de destino.

Todos os parâmetros são passados como parâmetros de query string na solicitação GET.

A API retorna um objeto JSON com a seguinte estrutura de nível superior:

{
  "ok": true,
  "api_version": "v1",
  "scanned_at": "2026-08-29T10:00:00.000Z",
  "page": {
    "url": "https://example.com",
    "title": "Example Domain",
    "meta_description": "This domain is for use in illustrative examples",
    "h1": "Example Domain",
    "word_count": 68,
    "images": { "total": 5, "missing_alt": 1 },
    "links": { "internal": 3, "external": 1 },
    "og": {
      "title": "Example Domain",
      "description": "This domain is for use in illustrative examples",
      "image": "https://example.com/og.png"
    },
    "canonical": "https://example.com",
    "robots": "index, follow",
    "schema_markup": true,
    "load_time_ms": 312,
    "status_code": 200
  },
  "score": {
    "current": 85,
    "max": 100,
    "percentage": 85
  },
  "recommendations": [
    {
      "type": "warning",
      "category": "Images",
      "title": "One image is missing alt text",
      "description": "Add descriptive alt text so the image is accessible and indexed.",
      "impact": "medium",
      "effort": "medium",
      "confidence": 90,
      "current_value": "Image without alt attribute",
      "suggested_value": "<img src=\"hero.jpg\" alt=\"Descriptive alt text\" />"
    }
  ],
  "ai_insights": "Add alt text to images and keep the meta description within 150 characters."
}

A API aplica um limite de taxa de 10 solicitações por minuto por endereço IP. Isso é generoso o suficiente para a maioria dos casos de uso de monitoramento, relatórios e desenvolvimento.

O limite de taxa é fixado em 10 solicitações por minuto por endereço IP para todos os usuários, independentemente do plano. Atualmente, não existe um plano pago que aumente esse limite.

Use a API em qualquer linguagem que suporte solicitações HTTP. Aqui estão exemplos em JavaScript e Python:

JavaScript (fetch)

async function auditUrl(url) {
  const response = await fetch(
    `https://www.auditme.dev/api/v1/audit?url=${encodeURIComponent(url)}`
  );

  if (!response.ok) {
    throw new Error(`Audit failed: ${response.status}`);
  }

  const data = await response.json();
  console.log("Overall Score:", data.score.percentage);
  console.log("Page Title:", data.page.title);
  console.log("Load Time:", data.page.load_time_ms + "ms");

  return data;
}

auditUrl("https://example.com");

Python (requests)

import requests
from urllib.parse import urlencode

def audit_url(url):
    params = {"url": url}
    response = requests.get(
        "https://www.auditme.dev/api/v1/audit",
        params=params
    )
    response.raise_for_status()
    data = response.json()

    print(f"Overall Score: {data['score']['percentage']}")
    print(f"Page Title: {data['page']['title']}")
    print(f"Load Time: {data['page']['load_time_ms']}ms")

    return data

audit_url("https://example.com")

cURL

# Basic GET request
curl "https://www.auditme.dev/api/v1/audit?url=https://example.com"

# Compact format (trimmed summary)
curl "https://www.auditme.dev/api/v1/audit?url=https://example.com&format=compact"

# Pretty-print JSON output
curl -s "https://www.auditme.dev/api/v1/audit?url=https://example.com" | jq .

Incorpore um distintivo de pontuação SEO ao vivo em qualquer site. O distintivo mostra a pontuação atual e liga diretamente ao relatório de auditoria.

Exemplos de incorporação

Image

<!-- Simple badge -->
<img src="https://www.auditme.dev/api/widget?domain=example.com" alt="SEO Score" style="border:0" />

<!-- Custom color and size -->
<img src="https://www.auditme.dev/api/widget?domain=example.com&color=3b82f6&size=large" alt="SEO Score" style="border:0" />

Iframe

<!-- Clickable badge (opens audit report) -->
<iframe
  src="https://www.auditme.dev/api/widget?domain=example.com&format=iframe"
  width="200" height="56" style="border:0"
  loading="lazy" title="SEO Score"
></iframe>

JavaScript

<!-- Live badge, auto-positioned bottom-right. Domain is auto-detected. -->
<script async src="https://www.auditme.dev/widget.js" data-color="10b981"></script>

<!-- Explicit domain + inline placement -->
<div id="auditme-widget"></div>
<script async src="https://www.auditme.dev/widget.js"
        data-domain="example.com" data-color="3b82f6"
        data-position="inline"></script>

<!-- White-label for agencies -->
<script async src="https://www.auditme.dev/widget.js"
        data-domain="example.com" data-brand="Your Agency"
        data-link="https://youragency.com/audit-offer"></script>