Entwickler

Öffentliche API

Lesen Sie Ihre Sites, Berichte, Rankings und Keywords über eine einfache, schlüssel-authentifizierte API. Agency-Funktion.

Öffentliche API

Die geführte Einrichtung finden Sie im Leitfaden zur öffentlichen API.

Die öffentliche API bietet Lesezugriff auf die Daten, die RankMeFast bereits für Ihr Konto hält, Sites, den letzten Audit-Bericht, den Ranking-Verlauf und die verfolgten Keywords. Sie ist eine Agency-Funktion (siehe Pläne, Limits & Guthaben). Die API löst niemals neue Anbieter-Arbeit aus, sie liest nur, was Ihre Audits und Ranking-Checks bereits erzeugt haben.

Das Starten einer Content-Intelligence-Analyse und Änderungen an Empfehlungen gehören nicht zu /api/v1. Diese Vorgänge bleiben angemeldete, durch Better Auth geschützte Produktfunktionen. MCP kann gespeicherte Analysen lesen, bietet aber kein Werkzeug zum Starten einer Inhaltsanalyse oder Ändern einer Empfehlung.

Authentifizierung

Erstellen Sie einen Schlüssel unter Konto → API-Schlüssel (/profile?tab=api-keys). Der vollständige Schlüssel wird genau einmal angezeigt, kopieren Sie ihn sofort; danach ist nur noch sein Präfix sichtbar. Sie können bis zu zehn aktive Schlüssel halten und jeden jederzeit widerrufen. Ein widerrufener Schlüssel funktioniert sofort nicht mehr.

Senden Sie den Schlüssel als Bearer-Token mit jeder Anfrage:

Authorization: Bearer rmf_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Ersetzen Sie https://your-rankme-host in den Beispielen unten durch Ihren api-Ursprung (die SERVER_URL Ihrer Installation).

Antwortsprache und Datenvertrag

Wählen Sie die Sprache der Texte zuerst mit x-lang, danach mit Accept-Language; ohne Treffer gilt en. Regionale Headerwerte wie fr-CA werden sicher zu fr normalisiert. /api/v1 ignoriert Browser-Cookies, Kontosprache und Workspace-Einstellungen. Jede Antwort nennt die wirksame Sprache in Content-Language und ergänzt Vary um x-lang, Accept-Language, ohne vorhandene Werte zu entfernen.

Nur von RankMeFast verfasste Berichts-, Befund-, Aktions- und sichere Fehlertexte werden lokalisiert. JSON-Eigenschaftsnamen, HTTP-Status, stabile Fehlercodes, Enum- und Statuswerte, IDs, Domains, URLs, Keywords, Zeitstempel, Messwerte, Beobachtungen, Cursor sowie gespeicherte Benutzer- oder Anbietertexte bleiben unverändert. Die Sprache beeinflusst weder Sortierung noch Zahlen- und Datumsformatierung.

CSV bleibt in jeder Antwortsprache ein byte-identischer Maschinenvertrag. UTF-8-BOM, Spaltennamen und -reihenfolge, Zeilenreihenfolge, RFC-4180-Escaping, Werte, Zeilenenden, Dateiname, Paginierungsheader und Cursorverhalten sind identisch. Content-Language beschreibt die Auswahl der Antwort; die CSV-Bytes werden weder übersetzt noch umbenannt.

Endpunkte

Ihre Sites auflisten

curl -H "Authorization: Bearer rmf_..." \
  https://your-rankme-host/api/v1/sites

Liefert { "sites": [{ "id", "domain", "url", "createdAt" }] }.

Letzter Audit-Bericht einer Site

curl -H "Authorization: Bearer rmf_..." \
  https://your-rankme-host/api/v1/sites/<siteId>/report/latest

Liefert den jüngsten erfolgreichen Audit als { "runId", "report" }, dieselben Befunde, Kategorien und lokalisierten Texte wie das Dashboard. Antwortet mit 404, wenn die Site noch keinen abgeschlossenen Audit hat.

Ranking-Verlauf einer Site

curl -H "Authorization: Bearer rmf_..." \
  "https://your-rankme-host/api/v1/sites/<siteId>/rank-history?from=2026-06-01&to=2026-07-01"

Liefert { "keywords": [{ "id", "phrase", "series": [...] }] }. Jeder Punkt enthält die Position, die rankende URL und die Google-AI-Overview-Signale (aiOverviewPresent, aiCited, aiCitedUrl). from und to sind optionale ISO-Daten.

Alle verfolgten Keywords

curl -H "Authorization: Bearer rmf_..." \
  https://your-rankme-host/api/v1/keywords

Liefert jedes verfolgte Keyword über alle Ihre Sites mit letzter Position, Delta und den AI-Overview-Feldern.

CSV-Exporte und gespeicherte Zeilen

Bei aktivem PUBLIC_EXPORTS_ENABLED liefert jede Listenroute CSV über ?format=csv oder Accept: text/csv. Die Dateien haben stabile Spalten, UTF-8-BOM, RFC-4180-Quoting und formelsicheren Text. Das JSON der vier ursprünglichen Routen bleibt unverändert. Der Rangverlauf akzeptiert engine=google|bing|youtube|amazon; ohne Filter enthält die Spalte engine alle Engines.

Rangverlaufs- und Keyword-CSV behalten ihre bisherige unpaginierte Ausgabe, solange weder limit noch ein undurchsichtiger cursor angegeben wird. Eine Rangverlaufsseite akzeptiert 1 bis 25 Keyword-Gruppen (höchstens 730 Punkte je Gruppe), eine Keyword-Seite 1 bis 1.000 Zeilen. Der Wert aus X-Next-Cursor wird an die nächste Anfrage übergeben; fehlt der Header, ist der Export vollständig. JSON ignoriert diese CSV-Paginierungsparameter und behält seinen ursprünglichen Vertrag.

Hinzu kommen GET /api/v1/serp-features?siteId=<siteId> und GET /api/v1/backlink-rows?siteId=<siteId> für gespeicherte Daten. Beide akzeptieren limit von 1 bis 1.000 und einen undurchsichtigen cursor, liefern nur kontoeigene Zeilen und kennzeichnen sie mit sourceKind=provider_observation (source_kind in CSV). Bei deaktiviertem Flag antworten neue Routen und CSV mit 503, ursprüngliches JSON bleibt aktiv. Der Looker-Studio-Leitfaden erklärt Connector und Felder.

Ratenlimits

Standardmäßig darf jeder Schlüssel 120 Anfragen pro Minute stellen. Darüber antwortet die API mit 429, bis das Fenster zurückgesetzt wird.

Fehler

Fehler haben die Form { "error": { "message": "...", "details": ... } }. Ihre sichere Meldung folgt x-lang, dann Accept-Language, dann en; Status, Felder, stabile Codes und sichere Details bleiben maschinenkompatibel:

401, der Schlüssel fehlt, ist fehlerhaft, widerrufen oder unbekannt.
402, Ihr Plan enthält die API nicht.
404, die Site oder der Bericht existiert in Ihrem Konto nicht.
429, Ratenlimit überschritten (Body: { "error": "..." }).

Kompatibilität

Dieses Release stellt genau sechs schreibgeschützte Routen bereit:

GET /api/v1/sites
GET /api/v1/sites/:siteId/report/latest
GET /api/v1/sites/:siteId/rank-history
GET /api/v1/keywords
GET /api/v1/serp-features
GET /api/v1/backlink-rows

Markenradar, Bewertungsanalyse, Link-Intelligenz, Traffic-Analyse, Keyword-Trends und SERP-Sensor fügen unter /api/v1 keine Routen hinzu. Die fünf kostenpflichtigen Funktionen bleiben im authentifizierten Dashboard; der öffentliche Sensor bleibt unter /api/volatility. Vorhandene Antwortfelder behalten ihre Bedeutung. Clients sollten zusätzliche unbekannte Felder ignorieren.

Zurück zum Dokumentationsindex