Géocodage direct

Transformez du texte en coordonnées. Accepte les adresses complètes, les adresses partielles, les codes postaux, les noms de lieux et les points d'intérêt, dans n'importe quelle langue.

Paramètres

Exemple

$ curl -H "X-API-Key: YOUR_KEY" "https://api.mygeocode.com/v1/forward?q=Dam+1,+Amsterdam&countries=nl&limit=1"

const url = new URL("https://api.mygeocode.com/v1/forward");
url.searchParams.set("q", "Dam 1, Amsterdam");
url.searchParams.set("countries", "nl");
url.searchParams.set("limit", "1");

const data = await (await fetch(url, { headers: { "X-API-Key": "YOUR_KEY" } })).json();
console.log(data.results[0]);

import requests

r = requests.get("https://api.mygeocode.com/v1/forward",
                 params={"q": "Dam 1, Amsterdam", "countries": "nl", "limit": 1}, headers={"X-API-Key": "YOUR_KEY"}, timeout=10)
print(r.json()["results"][0])

{
  "status": "ok",
  "query": "Dam 1, Amsterdam",
  "results": [
    {
      "formatted": "Dam 1, 1012 JS Amsterdam, Netherlands",
      "lat": 52.373119,
      "lon": 4.893604,
      "type": "address",
      "precision": "house",
      "confidence": 0.98,
      "place_id": "nl.addr.c21d40e8",
      "components": {
        "house_number": "1",
        "road": "Dam",
        "neighbourhood": "Centrum",
        "city": "Amsterdam",
        "state": "North Holland",
        "state_code": "NH",
        "postcode": "1012 JS",
        "country": "Netherlands",
        "country_code": "nl"
      },
      "bounds": { "north": 52.373519, "south": 52.372719, "east": 4.894204, "west": 4.893004 }
    }
  ]
}

Champs de la réponse

Clés des composants

Seules les clés pertinentes sont présentes. Les mêmes clés sont utilisées dans tous les pays.

Remarques

• Les résultats sont classés selon une combinaison de confiance, de précision et de proximité. Utilisez le premier résultat, sauf si vous affichez une liste de choix.
• Lorsqu'un numéro de rue est introuvable sur une voie connue, le résultat a type: street et precision: street, avec le numéro interpolé lorsque les données le permettent. Vérifiez precision si cela compte pour vous.
• Un code postal seul convient parfaitement comme q. Pour les usages limités aux codes postaux, l'endpoint des codes postaux est plus rapide et renvoie le nom de localité de l'autorité postale.
• Une requête écrite dans un alphabet pour un lieu qui en utilise un autre (du cyrillique pour une adresse japonaise, par exemple) fonctionne, mais c'est lang qui détermine l'alphabet de la réponse.

La même recherche aux formats d'autres fournisseurs

Si vous avez déjà du code écrit pour l'un de ces fournisseurs, gardez-le : l'hôte compatible accepte le même chemin et les mêmes paramètres et répond dans le format de réponse de ce fournisseur, avec cet endpoint derrière. Voir le fonctionnement des hôtes compatibles.

Recherches en masse

Envoyez en POST au même chemin un corps JSON avec queries, un tableau de jusqu'à 100 adresses, et la réponse contient un tableau results avec une entrée par requête, dans l'ordre d'envoi. Chaque entrée compte comme une requête, et un lot plus grand que ce qui reste du quota est refusé en entier.

$ curl -X POST "https://api.mygeocode.com/v1/forward" -H "Content-Type: application/json" -d '{"queries": ["Brandenburg Gate, Berlin", "Bahnhofstrasse 1, Zurich"]}'

Erreurs

400 invalid_request lorsque ni q, ni un champ structuré, ni place_id n'est présent, lorsque limit est en dehors de la plage 1 à 10, ou lorsque bounds ou proximity est mal formé. Voir les erreurs pour le reste.