REST API Dokumentation

Führen Sie SEO-Audits programmatisch über die CheckSEO REST API durch. Verfügbar in den Tarifen Agency und Enterprise.

Authentifizierung

Alle API-Anfragen müssen Ihren API-Schlüssel im Authorization-Header enthalten. Erstellen Sie API-Schlüssel in Ihren Kontoeinstellungen.

Authorization: Bearer csk_your_api_key_here

API-Schlüssel beginnen mit dem Präfix csk_. Halten Sie sie geheim — verwenden Sie sie nicht im clientseitigen Code.

Base URL

https://checkseo.site
POST /api/audits

Starten Sie ein neues SEO-Audit. Gibt audit_id zur Statusabfrage zurück.

Request Body (JSON)

Field Type Required Description
urlstringYesURL to audit
langstringNoReport language (en, ru, de, zh, hi, th, fr, es, cs, ar). Default: en
skip_performancebooleanNoSkip Google PageSpeed check
skip_broken_linksbooleanNoSkip broken links check

Beispiel

curl -X POST https://checkseo.site/api/audits \
  -H "Authorization: Bearer csk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "lang": "en"}'

Response (200)

{
  "audit_id": "a1b2c3d4e5f6...",
  "url": "https://example.com"
}
GET /api/audits/{audit_id}/status

Fragen Sie diesen Endpunkt ab, um den Audit-Fortschritt zu prüfen. Wenn der Status "done" ist, enthält das Feld redirect die Berichts-URL.

Response

// In progress
{"status": "running", "step": 3, "total": 8, "percent": 37}

// Completed
{"status": "done", "redirect": "/audits/a1b2c3d4...", "percent": 100}

// Error
{"status": "error", "error_message": "...", "percent": 0}
GET /audits/{audit_id}/pdf

Audit-Bericht als PDF herunterladen. Agency/Enterprise-Tarife erhalten ein sauberes PDF ohne Wasserzeichen.

Typischer Arbeitsablauf

1 POST /api/audits — Audit starten, audit_id erhalten
2 GET /api/audits/{id}/status — Alle 2-3 Sekunden abfragen, bis der Status "done" ist
3 GET /audits/{id} — Vollständigen Bericht ansehen
4 GET /audits/{id}/pdf — PDF herunterladen (optional)

Ratenlimits

Aktueller Plan Audits / Monat API
Free3
Registered5
Pro ($19/mo)30
Agency ($49/mo)100
Enterprise ($149/mo)500

Python-Beispiel

import requests, time

API_KEY = "csk_your_api_key"
BASE = "https://checkseo.site"
HEADERS = {"Authorization": f"Bearer {API_KEY}",
           "Content-Type": "application/json"}

# 1. Start audit
r = requests.post(f"{BASE}/api/audits",
                  json={"url": "https://example.com", "lang": "en"},
                  headers=HEADERS)
audit_id = r.json()["audit_id"]

# 2. Poll until done
while True:
    s = requests.get(f"{BASE}/api/audits/{audit_id}/status").json()
    if s["status"] == "done":
        break
    if s["status"] == "error":
        raise Exception(s["error_message"])
    time.sleep(2)

# 3. Download PDF
pdf = requests.get(f"{BASE}/audits/{audit_id}/pdf",
                   headers=HEADERS)
with open("report.pdf", "wb") as f:
    f.write(pdf.content)

API-Zugang ist in den Tarifen Agency ($49/Monat) und Enterprise ($149/Monat) verfügbar.

Tarife ansehen