API Hop

Dokumentation

API Hop-Dokumentation

SimilarwebAPI

Website-Traffic, Suchbegriffe, Backlinks, Verweise, Wettbewerber und Interaktion über authentifizierte REST-Endpunkte abfragen.

SimilarwebAPI bietet 27 schreibgeschützte Datenendpunkte unter /v1/similarweb. Verwenden Sie dasselbe Konto, denselben API-Schlüssel, dasselbe Guthaben und denselben Nutzungsverlauf wie für andere RequestBeam-APIs. Die Verfügbarkeit hängt von einem aktivierten Gateway und Ihren Schlüsselberechtigungen ab; die Dokumentation bestätigt keine Produktionsverfügbarkeit.

Authentifizierung

Senden Sie Ihren RequestBeam-API-Schlüssel, keine Zugangsdaten eines Drittanbieters:

http
Authorization: Bearer YOUR_API_KEY

Anfragebeispiel

Alle öffentlichen Operationen verwenden GET mit Abfrageparametern und ohne Anfragekörper. Behalten Sie die dokumentierte Groß- und Kleinschreibung von Pfaden und Parametern genau bei.

Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.

Bei Endpunkten mit Datumsparametern hat ein gültiger, vollständiger expliziter from/to-Zeitraum Vorrang. Akzeptiert der Endpunkt latest, muss ein angegebener Wert weiterhin die bestehende Format- und endpunktspezifische Validierung bestehen, wird aber bei der Zeitraumwahl ignoriert und nicht an Similarweb gesendet; ein Standardwert für latest wird nicht ergänzt. Ohne expliziten Zeitraum bleiben das bisherige latest-, Standardwert- und Fensterverhalten unverändert. Die History-Einschränkungen gelten weiterhin; Endpunkte ohne latest lehnen dieses Feld weiterhin ab.

bash
curl --get "https://api.apihop.ai/v1/similarweb/websites/incoming-referrals" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "key=example.com" \
  --data-urlencode "country=999" \
  --data-urlencode "page=1"

Eingehende Verweise verwenden einen einzelnen Hostnamen im kleingeschriebenen Parameter key, nicht keys. Dieser key ist ein fachlicher Abfrageparameter für die Zielwebsite, keine API-Zugangsinformation; er ist nur auf ausdrücklich freigegebenen Similarweb-GET-Routen erlaubt. Die API-Authentifizierung verwendet weiterhin Authorization; andere Zugangsdaten in Abfragefeldern bleiben verboten. Ergebniszeilen stehen in Records, nicht in Data. Die genauen Felder jeder Operation finden Sie in der vollständigen Endpunktreferenz.

Abdeckung

  • Suche: Keyword-Vorschläge, Rankingseiten, Website-Keywords, organische und bezahlte Suche, Markenkeywords.
  • Website-Traffic: Interaktion, Besuche, Geografie, Geräteverteilung, Kanäle und Social-Traffic.
  • Beziehungen: Backlinks, eingehende Verweise, ausgehender Traffic und ähnliche Websites.
  • Verlauf: getrennte Zeitreihen für monatliche Besuche, Absprungrate, Besuchsdauer und Seiten pro Besuch.

Antworten

Erfolgreiche Antworten behalten den nativen JSON-Körper ohne neue success/data-Hülle bei. Feldnamen, unbekannte Felder, leere Arrays und Zahlengenauigkeit bleiben unverändert. Unterschiedliche Endpunkte können Data, Records oder eine andere native Struktur liefern; gehen Sie nicht von einem einheitlichen Zeilenfeld aus.

Ein erfolgreiches leeres Ergebnis bedeutet nicht, dass die Domain keinen Traffic hat. Fehlgeschlagene Anfragen dürfen nicht als leere Daten behandelt werden. Bewahren Sie X-Request-Id und die Anfragezeit zur Fehlerbehebung auf.

Abrechnung und Paginierung

Der Standardpreis beträgt für alle 27 Endpunkte $0.0005 pro erfolgreicher Anfrage oder $0.50 pro 1,000 Anfragen. Abgerechnet wird pro Anfrage, nicht pro Zeile; auch ein erfolgreiches leeres Ergebnis zählt als eine Anfrage. Jede weitere Seite ist eine separate Anfrage. Falls eingerichtet, haben kontospezifische Preise Vorrang. Anfragen mit ungültigen Parametern, fehlender Autorisierung oder unzureichendem Guthaben werden nicht als erfolgreiche kostenpflichtige Aufrufe ausgeführt. Fehlgeschlagene Anfragen beim vorgelagerten Anbieter werden nicht berechnet.

Gemäß der Mindestguthabenregel der Plattform muss Ihr Konto vor einem Aufruf mindestens $0.10 verfügbar haben. Der Standardpreis bleibt $0.0005 pro erfolgreicher Anfrage.

Verwenden Sie nur die für den gewählten Endpunkt dokumentierten Paginierungsfelder. Die Seitennummerierung beginnt gewöhnlich bei 1; Backlinks verwenden Page und PageSize, andere Tabellen möglicherweise page, pageSize oder rowsPerPage. Senden Sie keine nicht unterstützten Seitengrößenfelder.

Fehler

Plattformfehler haben die folgende Struktur; code ist ein fachlicher Plattformcode, kein HTTP-Status:

json
{"success":false,"error":{"code":10000,"message":"Invalid request parameters"},"requestId":"..."}

Häufige HTTP-Statuswerte sind 400 für ungültige Abfragen, 401 für ungültige API-Schlüssel, 402 für unzureichendes Guthaben, 403 für verweigerten Gateway-Zugriff, 429 für Ratenlimits und 5xx für vorübergehende Anbieter- oder Dienstfehler. Wiederholen Sie fehlerhaft formatierte Anfragen nicht unverändert.