Documentación de la API de Auditoría SEO

Haz tu primera llamada a la API en segundos. Envía una solicitud GET con la URL de destino:

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

No se requiere autenticación. Recibirás una respuesta JSON con una auditoría SEO completa de la página especificada.

El endpoint de auditoría acepta una URL de destino como parámetro de consulta y devuelve un objeto JSON con el análisis SEO completo. La respuesta normalmente se completa en 5 a 15 segundos, según el tamaño de la página de destino.

Todos los parámetros se pasan como parámetros de cadena de consulta en la solicitud GET.

La API devuelve un objeto JSON con la siguiente estructura de nivel 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
  }
}

La API impone un límite de frecuencia de 10 solicitudes por minuto por dirección IP. Esto es suficiente para la mayoría de los casos de uso de monitoreo, informes y desarrollo.

Si necesitas límites de frecuencia más altos para cargas de trabajo de producción o aplicaciones empresariales, comunícate con nuestro equipo para obtener un plan personalizado.

Usa la API desde cualquier lenguaje que admita solicitudes HTTP. Aquí tienes ejemplos en JavaScript y 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>