API Hop

Documentación

Documentación de API Hop

SimilarwebAPI

Consulta tráfico web, palabras clave de búsqueda, enlaces entrantes, referencias, competidores e interacción mediante endpoints REST autenticados.

SimilarwebAPI proporciona 27 endpoints de datos de solo lectura bajo /v1/similarweb. Usa la misma cuenta, clave de API, saldo e historial de uso que las demás API de RequestBeam. La disponibilidad depende de una pasarela activada y de los permisos de tu clave; la documentación no confirma disponibilidad en producción.

Autenticación

Envía tu clave de API de RequestBeam, no una credencial de terceros:

http
Authorization: Bearer YOUR_API_KEY

Ejemplo de solicitud

Todas las operaciones públicas usan GET con parámetros de consulta y sin cuerpo. Conserva exactamente las mayúsculas y minúsculas documentadas de rutas y parámetros.

Solo se admiten datos de todo el mundo (country=999). Otros valores de país válidos se cambian a 999 antes de la solicitud al proveedor y devuelven datos mundiales, no del país indicado.

En los endpoints que aceptan fechas, un intervalo explícito from/to válido y completo tiene prioridad. Si el endpoint acepta latest, el valor enviado debe superar las validaciones existentes de formato y del endpoint, pero se ignora al seleccionar el intervalo y no se envía a Similarweb; tampoco se añade un latest predeterminado. Sin un intervalo explícito, se mantienen las reglas existentes de latest, valores predeterminados y ventanas. Las restricciones de History siguen vigentes; los endpoints que no aceptan latest siguen rechazándolo.

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"

Las referencias entrantes usan un único nombre de host en key, con minúscula, no keys. Este key es un parámetro de consulta de negocio del sitio objetivo, no una credencial de API; solo se permite en rutas GET de Similarweb expresamente autorizadas. La autenticación sigue usando Authorization y los demás parámetros de credenciales siguen prohibidos. Sus filas se devuelven en Records, no en Data. Consulta la referencia completa de endpoints para los campos exactos de cada operación.

Cobertura

  • Búsqueda: sugerencias de palabras clave, páginas clasificadas, palabras clave de sitios, búsqueda orgánica y de pago y palabras clave de marca.
  • Tráfico web: interacción, visitas, geografía, distribución por dispositivo, canales y tráfico social.
  • Relaciones: enlaces entrantes, referencias entrantes, tráfico saliente y sitios similares.
  • Historial: series separadas de visitas mensuales, tasa de rebote, duración de visita y páginas por visita.

Respuestas

Las respuestas correctas conservan el cuerpo JSON nativo, sin añadir una envoltura success/data. Los nombres de campos, campos desconocidos, matrices vacías y precisión numérica no cambian. Los distintos endpoints pueden devolver Data, Records u otra estructura nativa; no supongas que existe un campo universal de filas.

Un resultado vacío correcto no significa que el dominio no tenga tráfico. No trates las solicitudes fallidas como datos vacíos. Conserva X-Request-Id y la hora de la solicitud para diagnosticar problemas.

Facturación y paginación

El precio estándar es $0.0005 por solicitud correcta, o $0.50 por 1,000 solicitudes, para los 27 endpoints. Se factura por solicitud, no por fila; un resultado vacío correcto sigue contando como una solicitud. Cada página posterior es una solicitud separada. Los precios específicos de cuenta prevalecen si están configurados. Las solicitudes con parámetros no válidos, sin autorización o sin saldo suficiente no se procesan como llamadas correctas facturables. Las solicitudes fallidas al proveedor no se cobran.

Tu cuenta debe tener al menos $0.10 disponibles antes de una llamada, según la política de saldo mínimo de la plataforma. El cargo estándar sigue siendo $0.0005 por solicitud correcta.

Usa solo los campos de paginación documentados para el endpoint elegido. La paginación suele empezar en 1; los enlaces entrantes usan Page y PageSize, mientras que otras tablas pueden usar page, pageSize o rowsPerPage. No envíes campos de tamaño de página no admitidos.

Errores

Los errores de plataforma usan la siguiente estructura; code es un código de negocio de la plataforma, no un estado HTTP:

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

Los estados HTTP habituales incluyen 400 para consulta no válida, 401 para clave no válida, 402 para saldo insuficiente, 403 para acceso denegado a la pasarela, 429 para límite de velocidad y 5xx para fallos temporales del proveedor o servicio. No reintentes solicitudes mal formadas sin corregirlas.