SimilarwebAPI

SimilarwebAPI fournit 27 endpoints de données en lecture seule sous /v1/similarweb. Utilisez le même compte, la même clé API, le même solde et le même historique que pour les autres API RequestBeam. La disponibilité dépend d’une passerelle activée et des permissions de votre clé ; la documentation ne confirme pas une disponibilité en production.

Authentification

Envoyez votre clé API RequestBeam, pas un identifiant tiers :

Authorization: Bearer YOUR_API_KEY

Exemple de requête

Toutes les opérations publiques utilisent GET avec des paramètres de requête et sans corps. Respectez exactement la casse documentée des chemins et paramètres.

Seules les données mondiales sont prises en charge (country=999). Les autres valeurs de pays valides sont remplacées par 999 avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.

Pour les endpoints acceptant des dates, un intervalle explicite from/to valide et complet est prioritaire. Si l’endpoint accepte latest, la valeur fournie doit toujours respecter les validations existantes du format et de l’endpoint, mais elle est ignorée pour choisir l’intervalle et n’est pas envoyée à Similarweb ; aucune valeur latest par défaut n’est ajoutée. Sans intervalle explicite, les règles existantes de latest, des valeurs par défaut et des fenêtres restent inchangées. Les restrictions History restent applicables ; les endpoints qui n’acceptent pas latest continuent de le rejeter.

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"

Les sites référents entrants utilisent un seul nom d’hôte dans key, en minuscules, pas keys. Ce key est un paramètre de requête métier désignant le site cible, pas un identifiant API ; il n’est permis que sur les routes GET Similarweb expressément autorisées. L’authentification utilise toujours Authorization et les autres champs de requête d’identifiants restent interdits. Les lignes sont renvoyées dans Records, pas dans Data. Consultez la référence complète des endpoints pour les champs exacts de chaque opération.

Couverture

• Recherche : suggestions de mots-clés, pages classées, mots-clés des sites, recherche organique et payante, mots-clés de marque.
• Trafic web : engagement, visites, répartition géographique, appareils, canaux et trafic social.
• Relations : liens entrants, sites référents entrants, trafic sortant et sites similaires.
• Historique : séries distinctes de visites mensuelles, taux de rebond, durée des visites et pages par visite.

Réponses

Les réponses réussies conservent le corps JSON natif, sans nouvelle enveloppe success/data. Noms de champs, champs inconnus, tableaux vides et précision numérique restent inchangés. Selon l’endpoint, la réponse peut contenir Data, Records ou une autre structure native ; ne supposez pas un champ universel de lignes.

Un résultat vide réussi ne signifie pas que le domaine n’a aucun trafic. Les requêtes échouées ne doivent pas être traitées comme des données vides. Conservez X-Request-Id et l’heure de la requête pour le diagnostic.

Facturation et pagination

Le tarif standard est de $0.0005 par requête réussie, soit $0.50 pour 1,000 requêtes, sur les 27 endpoints. La facturation se fait par requête, pas par ligne ; un résultat vide réussi compte quand même comme une requête. Chaque page suivante constitue une requête distincte. Les tarifs propres au compte prévalent lorsqu’ils sont configurés. Les requêtes avec paramètres invalides, sans autorisation ou avec solde insuffisant ne deviennent pas des appels réussis facturables. Les requêtes échouées auprès du fournisseur ne sont pas facturées.

Votre compte doit disposer d’au moins $0.10 avant un appel, conformément à la politique de solde minimum. Le tarif standard reste de $0.0005 par requête réussie.

Utilisez uniquement les champs de pagination documentés pour l’endpoint choisi. La pagination commence généralement à 1 ; les liens entrants utilisent Page et PageSize, tandis que les autres tableaux peuvent utiliser page, pageSize ou rowsPerPage. N’envoyez pas de champs de taille de page non pris en charge.

Erreurs

Les erreurs de plateforme utilisent la structure suivante ; code est un code métier de la plateforme, pas un statut HTTP :

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

Les statuts HTTP courants comprennent 400 pour une requête invalide, 401 pour une clé API invalide, 402 pour un solde insuffisant, 403 pour un accès à la passerelle refusé, 429 pour une limite de débit et 5xx pour une défaillance temporaire du fournisseur ou du service. Ne relancez pas une requête mal formée sans la corriger.