Référence de l'API de géolocalisation du visiteur

GET/v1/geo

Renvoie la position et les données d'enrichissement disponibles pour le client connecté. Appelez-le depuis le navigateur d'un visiteur pour décrire la connexion de ce visiteur — une requête depuis le serveur de votre application décrit plutôt la connexion du serveur lui-même.

Authentification

Fournissez une clé publiable restreinte par origine via l'en-tête X-Api-Key, ou le paramètre de requête key en alternative. Le contrôle d'accès provient de la liste des origines autorisées configurée pour la clé, vérifiée par rapport à l'en-tête Origin/Referer de la requête — pas du fait de garder la clé secrète, puisqu'elle est conçue pour apparaître dans le code source du navigateur.

Champs de la réponse

ip: L'adresse IP du client connecté.
country, region, regionCode, city, postalCode, continent: Position approximative, annulable (null) lorsque les données Edge sous-jacentes n'en résolvent aucune.
latitude, longitude: Coordonnées approximatives de la position résolue, pas une position d'appareil ou GPS.
timezone: Nom de fuseau horaire IANA, ou null si indisponible.
isEUCountry: Booléen ; un indicateur de localisation, pas une qualification juridique.
asn, asOrganization: Le réseau connecté et son opérateur, lorsqu'ils sont fournis par les données sous-jacentes ; sinon null.
currency, callingCode: Contexte régional dérivé du pays résolu, ou null.
locale, holidays, compliance, tax, ageVerification: Groupes d'enrichissement dérivés optionnels, chacun indépendamment annulable. Aucun d'eux n'est une qualification juridique, fiscale ou d'identité.
hostname: Présent uniquement lorsqu'il est demandé via ?include=hostname ; un résultat de recherche DNS inversée, null en cas d'échec.
security: Totalement omis sur les forfaits qui ne l'incluent pas. Lorsqu'il est présent : isTor, isVpn, isDatacenter, isThreat, isSanctionedNetwork — des indicateurs basés sur des listes. La détection Tor en IPv6 n'est pas actuellement implémentée ; false signifie une absence de correspondance dans les données disponibles, pas une absence de risque.

Erreurs

401: Clé API manquante ou invalide.
403: L'Origin/Referer de la requête ne figure pas dans la liste des origines autorisées de la clé. Aucun en-tête CORS n'est défini sur cette réponse, donc le navigateur la bloque quel que soit le corps JSON.
429: Limite de débit dépassée pour la fenêtre fixe d'une minute en cours.

Exemple

Requête

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

Réponse — à titre d'illustration ; les champs varient selon le forfait et les données 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"
}

Limites

Soumis au plafond mensuel de requêtes et à la limite de débit par minute de votre forfait — voir tarification. Chaque appel réussi est enregistré comme un événement d'utilisation geo.