Referencia de la API de geolocalización de visitantes

GET/v1/geo

Devuelve la ubicación disponible y los datos de enriquecimiento del cliente que se conecta. Llámala desde el navegador de un visitante para describir la conexión de ese visitante; una solicitud desde el servidor de tu aplicación describe en cambio la propia conexión del servidor.

Autenticación

Proporciona una clave publicable restringida por origen mediante el encabezado X-Api-Key, o el parámetro de consulta key como alternativa. El control de acceso proviene de la lista de orígenes permitidos configurada para la clave, verificada contra el encabezado Origin/Referer de la solicitud, no de mantener la clave en secreto, ya que está diseñada para aparecer en el código fuente del navegador.

Campos de la respuesta

ip: La dirección IP del cliente que se conecta.
country, region, regionCode, city, postalCode, continent: Ubicación aproximada, anulable cuando los datos de borde subyacentes no logran resolver una.
latitude, longitude: Coordenadas aproximadas para la ubicación resuelta, no una posición de dispositivo o GPS.
timezone: Nombre de zona horaria IANA, o null cuando no está disponible.
isEUCountry: Booleano; es un indicador locacional, no una determinación legal.
asn, asOrganization: La red que se conecta y su operador, cuando los datos subyacentes lo proporcionan; de lo contrario, null.
currency, callingCode: Contexto regional derivado del país resuelto, o null.
locale, holidays, compliance, tax, ageVerification: Grupos de enriquecimiento derivados opcionales, cada uno anulable de forma independiente. Ninguno de estos son determinaciones legales, fiscales o de identidad.
hostname: Solo presente cuando se solicita mediante ?include=hostname; un resultado de consulta DNS inversa, null si falla.
security: Se omite por completo en los planes que no lo incluyen. Cuando está presente: isTor, isVpn, isDatacenter, isThreat, isSanctionedNetwork: indicadores basados en listas. La detección de Tor sobre IPv6 no está implementada actualmente; false significa que no hay coincidencia en los datos disponibles, no una ausencia de riesgo.

Errores

401: Clave de API faltante o no válida.
403: El Origin/Referer de la solicitud no está en la lista de orígenes permitidos de la clave. Tampoco se configura ningún encabezado CORS en esta respuesta, así que el navegador la bloquea sin importar el cuerpo JSON.
429: Límite de tasa superado para la ventana fija de un minuto actual.

Ejemplo

Solicitud

curl https://api.watch-ip.com/v1/geo \
  -H "X-Api-Key: YOUR_PUBLISHABLE_KEY"

Respuesta — ilustrativa; los campos varían según el plan y los datos disponibles

{
  "ip": "203.0.113.1",
  "country": "US",
  "region": "Texas",
  "regionCode": "TX",
  "city": "Austin",
  "postalCode": "78701",
  "latitude": 30.2672,
  "longitude": -97.7431,
  "continent": "NA",
  "timezone": "America/Chicago",
  "isEUCountry": false,
  "asn": 12345,
  "asOrganization": "Example ISP",
  "currency": { "code": "USD", "name": "US Dollar", "symbol": "$" },
  "callingCode": "+1"
}

Límites

Sujeto al límite mensual de solicitudes y al límite de tasa por minuto de tu plan; consulta precios. Cada llamada exitosa se registra como un evento de uso de geo.