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:

{
  "success": true,
  "url": "https://example.com",
  "audit": {
    "meta": {
      "title": "Example Domain",
      "titleLength": 13,
      "description": "This domain is for use in...",
      "descriptionLength": 36,
      "h1": ["Example Domain"],
      "canonical": "https://example.com",
      "ogTitle": "Example Domain",
      "ogDescription": "This domain is for use in...",
      "ogImage": "https://example.com/image.png"
    },
    "performance": {
      "lcp": 1.2,
      "inp": 85,
      "cls": 0.05,
      "fcp": 0.8,
      "ttfb": 120,
      "score": 92
    },
    "schema": {
      "valid": true,
      "types": ["WebPage", "Organization"],
      "errors": [],
      "warnings": []
    },
    "content": {
      "score": 78,
      "wordCount": 1250,
      "readabilityScore": "A",
      "keywordDensity": 2.1
    },
    "links": {
      "internal": 12,
      "external": 3,
      "broken": 0
    },
    "images": {
      "total": 5,
      "missingAlt": 0
    },
    "overallScore": 85
  }
}

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.

Se você precisar de limites de taxa mais altos para cargas de trabalho de produção ou aplicações empresariais, entre em contato com nossa equipe para um plano personalizado.

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.audit.overallScore);
  console.log("Meta Title:", data.audit.meta.title);
  console.log("LCP:", data.audit.performance.lcp + "s");

  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['audit']['overallScore']}")
    print(f"Meta Title: {data['audit']['meta']['title']}")
    print(f"LCP: {data['audit']['performance']['lcp']}s")

    return data

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

cURL

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

# With text format
curl "https://www.auditme.dev/api/v1/audit?url=https://example.com&format=text"

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

apiDocs.widgetDesc

apiDocs.widgetEmbedTitle

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>