Recherche de code postal

Un code postal en entrée, la localité à laquelle il appartient en sortie. Couvre 160 pays.

GEThttps://api.mygeocode.com/v1/postcode

Paramètres

Paramètre	Type	Description
`code`obligatoire	chaîne	Le code postal. Les espaces, les tirets et la casse sont normalisés.
`country`facultatif	chaîne	Code ISO 3166-1 alpha-2. Fortement recommandé ; les codes postaux ne sont pas uniques d'un pays à l'autre. Sans lui, les résultats de tous les pays correspondants sont renvoyés, par population décroissante.
`lang`facultatif	chaîne	Code ISO 639-1 pour les noms de localité et de région. Par défaut `en`.
`key`facultatif	chaîne	Clé d'API, si elle n'est pas envoyée dans un en-tête.

Exemple

curlJavaScriptPython

$ curl -H "X-API-Key: YOUR_KEY" "https://api.mygeocode.com/v1/postcode?code=75008&country=fr"

const url = new URL("https://api.mygeocode.com/v1/postcode");
url.searchParams.set("code", "75008");
url.searchParams.set("country", "fr");

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

import requests

r = requests.get("https://api.mygeocode.com/v1/postcode", params={"code": "75008", "country": "fr"}, headers={"X-API-Key": "YOUR_KEY"}, timeout=5)
first = r.json()["results"][0]
print(first["place"], first["lat"], first["lon"])

Réponse

{
  "status": "ok",
  "postcode": "75008",
  "country_code": "FR",
  "results": [
    {
      "postcode": "75008",
      "place": "Paris 8e Arrondissement",
      "region": "Ile-de-France",
      "region_code": "IDF",
      "country": "France",
      "country_code": "FR",
      "lat": 48.8727,
      "lon": 2.3125
    }
  ]
}

Champs de la réponse

Champ	Type	Description
`postcode`	chaîne	Le code après normalisation.
`country_code`	chaîne ou null	Le filtre de pays appliqué, le cas échéant.
`results`	tableau	Les localités couvertes par le code. Généralement une seule ; plusieurs pour les codes ruraux qui englobent des villages. Vide si le code est inconnu.
`results[].place`	chaîne	Nom de la localité tel que l'utilise l'autorité postale.
`results[].region`, `region_code`	chaîne	Division de premier niveau et son suffixe ISO 3166-2.
`results[].lat`, `lon`	nombre	Le point publié par l'autorité postale s'il existe, sinon le centroïde des adresses du code.

Remarques

Les codes partiels fonctionnent lorsque le système du pays est hiérarchique : SW1A pour le Royaume-Uni renvoie le district ; 750 pour la France ne renvoie rien, car les codes français ne sont pas des préfixes.
Les pays sans codes postaux (l'Irlande avant Eircode, plusieurs pays d'Afrique et du Moyen-Orient) renvoient un tableau results vide avec status: ok.
Pour une adresse complète avec numéro de rue, utilisez le géocodage direct ; le code postal l'aide aussi.

Erreurs

400 invalid_request lorsque code est vide ou dépasse 16 caractères, ou que country n'est pas un code alpha-2 valide.