Referência da API de Geolocalização de Visitante

GET/v1/geo

Devolve os dados de localização e enriquecimento disponíveis do cliente em ligação. Chame-o a partir do navegador de um visitante para descrever a ligação desse visitante — um pedido a partir do servidor da sua aplicação descreve antes a própria ligação do servidor.

Autenticação

Forneça uma chave publicável bloqueada por origem através do cabeçalho X-Api-Key, ou o parâmetro de consulta key como alternativa. O controlo de acesso vem da lista de origens permitidas configurada para a chave, verificada em função do cabeçalho Origin/Referer do pedido — não do sigilo da chave, uma vez que esta foi concebida para aparecer no código-fonte do navegador.

Campos de resposta

ip: O endereço IP do cliente em ligação.
country, region, regionCode, city, postalCode, continent: Localização aproximada, anulável quando os dados de edge subjacentes não resolvem uma.
latitude, longitude: Coordenadas aproximadas para a localização resolvida, não uma posição de dispositivo ou GPS.
timezone: Nome de fuso horário IANA, ou nulo quando indisponível.
isEUCountry: Booleano; um indicador de localização, não uma determinação legal.
asn, asOrganization: A rede em ligação e o seu operador, quando fornecidos pelos dados subjacentes; caso contrário, nulo.
currency, callingCode: Contexto regional derivado do país resolvido, ou nulo.
locale, holidays, compliance, tax, ageVerification: Grupos de enriquecimento derivados e opcionais, cada um anulável de forma independente. Nenhum destes constitui uma determinação legal, fiscal, ou de identidade.
hostname: Apenas presente quando pedido via ?include=hostname; um resultado de pesquisa de DNS inverso, nulo se falhar.
security: Omitido por completo nos planos que não o incluem. Quando presente: isTor, isVpn, isDatacenter, isThreat, isSanctionedNetwork — indicadores baseados em listas. A deteção de Tor em IPv6 não está atualmente implementada; false significa que não houve correspondência nos dados disponíveis, não uma ausência de risco.

Erros

401: Chave de API em falta ou inválida.
403: O Origin/Referer do pedido não consta da lista de origens permitidas da chave. Não é definido qualquer cabeçalho CORS nesta resposta, pelo que o navegador a bloqueia independentemente do corpo JSON.
429: Limite de taxa excedido para a janela fixa de um minuto atual.

Exemplo

Pedido

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

Resposta — ilustrativa; os campos variam consoante o plano e os dados disponíveis

{
  "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"
}

Limites

Sujeito ao limite mensal de pedidos e ao limite de taxa por minuto do seu plano — consulte preços. Cada chamada bem-sucedida é registada como um evento de utilização de geo.