Documentación de API Hop
Referencia de endpoints de SimilarwebAPI
Los 27 endpoints GET de SimilarwebAPI con nombres exactos de parámetros, tipos, límites, ventanas de fechas y comportamiento de respuesta.
Todas las rutas siguientes son relativas al origen de tu API. Cada solicitud requiere Authorization: Bearer YOUR_API_KEY, usa GET y no tiene cuerpo. Consulta autenticación, facturación y errores.
Reglas de consulta
Los campos singulares de sitio key y Key requieren un solo dominio ASCII, como amazon.com, de hasta 253 caracteres y sin espacios alrededor. No envíes URL, direcciones IP, listas de dominios ni credenciales de API en estos campos. Usa punycode para dominios internacionalizados.
Los nombres de parámetros distinguen mayúsculas y minúsculas. Se rechazan campos desconocidos o duplicados, CR/LF/NUL y valores no válidos. Los booleanos son los literales true o false; cero no equivale a false. El texto debe tener de 1 a 2048 bytes UTF-8 tras recortar espacios. Codifica espacios, matrices JSON y separadores con el codificador de parámetros de tu cliente HTTP.
from y to deben aparecer juntos, ser fechas reales en formato YYYY-MM-DD o YYYY|MM|DD y cumplir from <= to. El par de comparación sigue la misma regla. Los campos opcionales heredan los valores predeterminados del endpoint; las tablas enumeran los campos permitidos, no obligan a enviarlos todos.
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.
Sin un intervalo explícito from/to: Las rutas por ventana suelen usar por defecto 28 días que terminan tres días UTC atrás y aceptan de latest=1d a 366d. Las rutas de meses fijos tienen los valores indicados abajo. Interacción, visitas, rankings y canales también aceptan latest=1m|2m|3m|6m para meses naturales UTC completos anteriores; estos selectores requieren isWindow=false y usan timeGranularity=Monthly por defecto. El historial tiene reglas más restringidas documentadas en sus cuatro endpoints.
Solo se admiten datos de todo el mundo (country=999). Los identificadores de sitios son dominios como example.com, excepto en el endpoint de rankings por palabra clave, donde keys es una palabra clave de búsqueda. La disponibilidad de datos, filtros y tipos de coincidencia del proveedor puede variar. 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.
Las respuestas correctas conservan el JSON nativo, sin adoptar un esquema universal. Las tablas de referencias entrantes y salientes usan Records; las métricas históricas pueden usar Data anidado. Los nombres y unidades descritos abajo no implican que todos los campos opcionales del proveedor estén siempre presentes.
Puntos de acceso
Sugerencias de palabras clave
GET https://api.apihop.ai/v1/similarweb/keywords/suggestions
Valores predeterminados: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total y windowVolume descendente. El campo opcional page empieza en 1. rangeFilter usa sintaxis nativa, por ejemplo volume,100,10000|difficulty,0,40. La disponibilidad de tipos de coincidencia y filtros depende de la fuente. Solo se admiten datos de todo el mundo (country=999).
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keyword | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
sort | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
asc | No | cadena booleana: true o false |
page | No | cadena de entero; 1-1000 |
rowsPerPage | No | cadena de entero; 1-1000 |
type | No | cadena; enumeración: Broad, Phrase, Exact, Related |
websource | No | cadena; enumeración: Total, Desktop, MobileWeb |
isWindow | No | cadena booleana: true o false |
rangeFilter | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Enlaces entrantes
GET https://api.apihop.ai/v1/similarweb/websites/backlinks
Valores predeterminados: Page 1, PageSize 100, Status All, FollowType All y DomainScore descendente. Key lleva mayúscula; no uses key ni keys.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
Key | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Page | No | cadena de entero; 1-1000 |
PageSize | No | cadena de entero; 1-1000 |
Status | No | cadena; enumeración: All, Active, New, Lost |
FollowType | No | cadena; enumeración: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow |
DomainScoreFrom | No | cadena de entero; 0-100 |
DomainScoreTo | No | cadena de entero; 0-100 |
sort | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
asc | No | cadena booleana: true o false |
Palabras clave de un sitio
GET https://api.apihop.ai/v1/similarweb/websites/keywords
Valores predeterminados: page 1, pageSize 100, sourceType all y ambas opciones de marca false. pageFilterJson es una sola cadena de matriz JSON codificada para URL; si se omite, toma keys como dominio objetivo. Sin un intervalo explícito from/to: latest=1m selecciona el resumen de un mes con pageSize 5 e isWindow=false salvo que se indiquen explícitamente. Usa sourceType=organic o paid con IncludeNoneBranded=true e IncludeBranded=false para vistas de palabras clave sin marca.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Daily, Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
sort | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
asc | No | cadena booleana: true o false |
iso | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
isDaily | No | cadena booleana: true o false |
IncludeBranded | No | cadena booleana: true o false |
IncludeNoneBranded | No | cadena booleana: true o false |
page | No | cadena de entero; 1-1000 |
pageSize | No | cadena de entero; 1-1000 |
sourceType | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
pageFilterJson | No | cadena que contiene una matriz JSON |
Sitios clasificados por palabra clave
GET https://api.apihop.ai/v1/similarweb/keywords/websites
keys es una palabra clave, no un dominio. Los valores predeterminados incluyen selectedPageTab=Organic, sourceType=organic, Device=Total y graphDuration=28d. Los campos opcionales page y pageSize usan enteros que empiezan en 1 o son positivos.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Daily, Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
sort | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
asc | No | cadena booleana: true o false |
iso | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
isDaily | No | cadena booleana: true o false |
tab | No | cadena de entero no negativo |
mtd | No | cadena booleana: true o false |
selectedPageTab | No | cadena; enumeración: Organic, Paid |
graphDuration | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
graphType | No | cadena de entero; 1-1000 |
isDurationChanged | No | cadena booleana: true o false |
ignoreFilterConsistency | No | cadena booleana: true o false |
Device | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
sourceType | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
page | No | cadena de entero; 1-1000 |
pageSize | No | cadena de entero; 1-1000 |
Fuentes de tráfico
GET https://api.apihop.ai/v1/similarweb/websites/traffic-sources
Valores predeterminados: sourceType=Referral, page=1, orderBy=Share desc y timeGranularity=Daily. Esta tabla es distinta del endpoint incoming-referrals.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Daily, Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
sourceType | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
ignoreFilterConsistency | No | cadena booleana: true o false |
page | No | cadena de entero; 1-1000 |
orderBy | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Tráfico saliente
GET https://api.apihop.ai/v1/similarweb/websites/outgoing-traffic
from y to son obligatorios. Solo key singular. Valores predeterminados: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby y orderBy son distintos y se reenvían independientemente; mantenlos coherentes. No se admiten latest, pageSize, rowsPerPage, includeSubDomains ni timeGranularity. Las filas están en Records; TotalCount es el total del proveedor, no la longitud de la página actual. Solo se admiten datos de todo el mundo (country=999).
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
key | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | Sí | cadena; fecha válida en los formatos anteriores |
to | Sí | cadena; fecha válida en los formatos anteriores |
isWWW | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
orderby | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
orderBy | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
sort | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
asc | No | cadena booleana: true o false |
page | No | cadena de entero; 1-1000 |
Referencias entrantes
GET https://api.apihop.ai/v1/similarweb/websites/incoming-referrals
Solo key singular. Valores predeterminados: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. No se admiten keys, pageSize, rowsPerPage, includeSubDomains ni timeGranularity. Las filas están en Records; los campos nativos pueden incluir SiteOrigins y TotalShare. Solo se admiten datos de todo el mundo (country=999).
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
key | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
isWWW | No | cadena booleana: true o false |
iso | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
isWindow | No | cadena booleana: true o false |
isDaily | No | cadena booleana: true o false |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
selectedTab | No | cadena; enumeración: incomingTraffic |
orderBy | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
ignoreFilterConsistency | No | cadena booleana: true o false |
page | No | cadena de entero; 1-1000 |
Proporción de palabras clave de marca
GET https://api.apihop.ai/v1/similarweb/websites/branded-keywords
El valor predeterminado es el mes natural UTC completo anterior. duration está fijado en 1m.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Daily, Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
duration | No | cadena; enumeración: 1m |
Distribución geográfica del tráfico
GET https://api.apihop.ai/v1/similarweb/websites/geography
Los valores predeterminados son los tres meses naturales UTC completos anteriores, pageSize=5 y orderBy=TotalShare desc.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Daily, Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
pageSize | No | cadena de entero; 1-1000 |
orderBy | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Distribución por dispositivos
GET https://api.apihop.ai/v1/similarweb/websites/devices
Los valores predeterminados son los tres meses naturales UTC completos anteriores y ShouldGetVerifiedData=false.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Daily, Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
ShouldGetVerifiedData | No | cadena booleana: true o false |
Rendimiento de búsqueda
GET https://api.apihop.ai/v1/similarweb/websites/search-performance
Los valores predeterminados son el mes natural UTC completo anterior, pageSize=5, duration=1m y SourceType=Organic. Usa SourceType=Paid para palabras clave de pago; no lo sustituyas por sourceType.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Daily, Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
pageSize | No | cadena de entero; 1-1000 |
duration | No | cadena; enumeración: 1m |
SourceType | No | cadena; enumeración: Organic, Paid |
Tráfico social
GET https://api.apihop.ai/v1/similarweb/websites/social-traffic
El valor predeterminado son los tres meses naturales UTC completos anteriores. webSource no se acepta.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
timeGranularity | No | cadena; enumeración: Daily, Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Resumen de interacción
GET https://api.apihop.ai/v1/similarweb/websites/engagement
Los valores predeterminados incluyen ShouldGetVerifiedData=false, includeLeaders=true y unBounced=false. Las filas nativas de Data pueden contener AvgMonthVisits, BounceRate, PagesPerVisit y AvgVisitDuration.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Daily, Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
ShouldGetVerifiedData | No | cadena booleana: true o false |
includeLeaders | No | cadena booleana: true o false |
unBounced | No | cadena booleana: true o false |
beta | No | cadena booleana: true o false |
Visitas totales
GET https://api.apihop.ai/v1/similarweb/websites/visits
compareFrom y compareTo deben enviarse juntos como fechas válidas y ordenadas. timeGranularity es Monthly. Los campos nativos pueden incluir TotalVisits, Change y ShareOfVisits; un total móvil no es necesariamente el total de un mes natural completo.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
compareFrom | No | cadena; fecha válida en los formatos anteriores |
compareTo | No | cadena; fecha válida en los formatos anteriores |
ShouldGetVerifiedData | No | cadena booleana: true o false |
Tabla de visitas
GET https://api.apihop.ai/v1/similarweb/websites/visits/table
compareFrom y compareTo deben enviarse juntos como fechas válidas y ordenadas. timeGranularity es Monthly; las filas están en Data, con Domain y TotalVisits. TotalCount puede ser 0 aunque Data contenga filas; inspecciona la matriz para saber si hay resultados.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
compareFrom | No | cadena; fecha válida en los formatos anteriores |
compareTo | No | cadena; fecha válida en los formatos anteriores |
ShouldGetVerifiedData | No | cadena booleana: true o false |
Tendencia de visitas
GET https://api.apihop.ai/v1/similarweb/websites/visits/trend
El valor predeterminado es la ventana móvil diaria de 28 días. timeGranularity acepta Daily, Weekly o Monthly.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Daily, Weekly, Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
ShouldGetVerifiedData | No | cadena booleana: true o false |
Rankings del sitio
GET https://api.apihop.ai/v1/similarweb/websites/ranks
timeGranularity es Monthly. La respuesta nativa usa objetos distintos GlobalRank, CountryRank y CategoryRank.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Rankings por país
GET https://api.apihop.ai/v1/similarweb/websites/ranks/country
timeGranularity es Monthly. Esta es la tabla explícita de ranking por país, no la respuesta combinada de rankings. Las filas están en Data, con Domain y Rank. TotalCount puede ser 0 aunque haya filas; inspecciona directamente Data.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Rankings globales
GET https://api.apihop.ai/v1/similarweb/websites/ranks/global
timeGranularity es Monthly. Devuelve la tabla separada de ranking global. Las filas están en Data, con Domain y Rank. TotalCount puede ser 0 aunque haya filas; inspecciona directamente Data.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Rankings por categoría
GET https://api.apihop.ai/v1/similarweb/websites/ranks/category
timeGranularity es Monthly. Devuelve la tabla separada de ranking por sector/categoría. Las filas están en Data, con Domain y Rank. TotalCount puede ser 0 aunque haya filas; inspecciona directamente Data.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Canales de tráfico
GET https://api.apihop.ai/v1/similarweb/websites/channels
El valor predeterminado es la ventana móvil diaria de 28 días. Con webSource=Total, los valores de los canales están bajo Data.Total[domain], no directamente bajo Data[domain]. Se conservan los nombres de canales, como Search - Organic y Direct. Los valores son números de visitas; calcula proporciones solo si su suma es positiva.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Daily, Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Sitios similares
GET https://api.apihop.ai/v1/similarweb/websites/similar-sites
El valor predeterminado son los tres meses naturales UTC completos anteriores. isWindow debe ser false, timeGranularity es Monthly y orderBy está fijado en Affinity desc. No se admiten latest ni webSource.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
timeGranularity | No | cadena; enumeración: Monthly |
orderBy | No | cadena; enumeración: Affinity desc |
Sugerencias de sitios similares
GET https://api.apihop.ai/v1/similarweb/websites/similar-sites/suggestions
key singular; limit tiene un valor predeterminado de 20 y debe estar entre 1 y 20. country usa 999 por defecto y webSource Total. La respuesta nativa observada es una matriz de candidatos sin envoltura, con Domain, DomainWithoutSub, Rank numérico y Favicon; no esperes una envoltura Data. Una matriz vacía no contiene sugerencias. Solo se admiten datos de todo el mundo (country=999).
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
key | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
limit | No | cadena de entero; 1-20 |
country | No | cadena de entero no negativo; 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. |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
Historial de visitas mensuales
GET https://api.apihop.ai/v1/similarweb/websites/history/visits
El valor predeterminado son los seis meses naturales UTC completos anteriores. Solo se admiten country=999, isWindow=false y timeGranularity=Monthly. latest acepta de 1m a 6m; las fechas explícitas deben cubrir meses completos dentro de esa ventana móvil de seis meses. Las series nativas pueden aparecer bajo Data.<domain>.<source> con puntos Key/Value; se conservan los nombres de origen, incluidos MobileWeb o Mobile Web. Los valores representan visitas estimadas.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Historial mensual de tasa de rebote
GET https://api.apihop.ai/v1/similarweb/websites/history/bounce-rate
El valor predeterminado son los seis meses naturales UTC completos anteriores. Solo se admiten country=999, isWindow=false y timeGranularity=Monthly. latest acepta de 1m a 6m; las fechas explícitas deben cubrir meses completos dentro de esa ventana móvil de seis meses. Las series nativas pueden aparecer bajo Data.<domain>.<source> con puntos Key/Value; se conservan los nombres de origen, incluidos MobileWeb o Mobile Web. Los valores representan fracciones de tasa de rebote.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Historial mensual de duración de visita
GET https://api.apihop.ai/v1/similarweb/websites/history/visit-duration
El valor predeterminado son los seis meses naturales UTC completos anteriores. Solo se admiten country=999, isWindow=false y timeGranularity=Monthly. latest acepta de 1m a 6m; las fechas explícitas deben cubrir meses completos dentro de esa ventana móvil de seis meses. Las series nativas pueden aparecer bajo Data.<domain>.<source> con puntos Key/Value; se conservan los nombres de origen, incluidos MobileWeb o Mobile Web. Los valores representan segundos por visita.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
Historial mensual de páginas por visita
GET https://api.apihop.ai/v1/similarweb/websites/history/pages-per-visit
El valor predeterminado son los seis meses naturales UTC completos anteriores. Solo se admiten country=999, isWindow=false y timeGranularity=Monthly. latest acepta de 1m a 6m; las fechas explícitas deben cubrir meses completos dentro de esa ventana móvil de seis meses. Las series nativas pueden aparecer bajo Data.<domain>.<source> con puntos Key/Value; se conservan los nombres de origen, incluidos MobileWeb o Mobile Web. Los valores representan páginas por visita.
| Campo de consulta | Obligatorio | Tipo y restricciones |
|---|---|---|
keys | Sí | cadena; 1-2048 bytes UTF-8 tras recortar espacios |
country | No | cadena de entero no negativo; 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. |
from | No | cadena; fecha válida en los formatos anteriores |
to | No | cadena; fecha válida en los formatos anteriores |
includeSubDomains | No | cadena booleana: true o false |
isWindow | No | cadena booleana: true o false |
webSource | No | cadena; enumeración: Total, Desktop, MobileWeb |
timeGranularity | No | cadena; enumeración: Monthly |
latest | No | cadena; 1-2048 bytes UTF-8 tras recortar espacios |