Consulta de códigos postales

Entra un código postal, sale el lugar al que pertenece. Cubre 160 países.

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

Parámetros

Parámetro	Tipo	Descripción
`code`obligatorio	string	El código postal. Los espacios, los guiones y las mayúsculas se normalizan.
`country`opcional	string	Código ISO 3166-1 alfa-2. Muy recomendable; los códigos postales no son únicos entre países. Sin él, se devuelven resultados de todos los países que coinciden, primero los de mayor población.
`lang`opcional	string	Código ISO 639-1 para los nombres de lugares y regiones. Por defecto `en`.
`key`opcional	string	Clave de API, si no se envía como cabecera.

Ejemplo

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"])

Respuesta

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

Campos de la respuesta

Campo	Tipo	Descripción
`postcode`	string	El código tras la normalización.
`country_code`	string o null	El filtro de país aplicado, si lo hay.
`results`	array	Los lugares que cubre el código. Normalmente uno; varios en códigos rurales que abarcan varias localidades. Vacío si el código es desconocido.
`results[].place`	string	Nombre de la localidad tal como lo usa la autoridad postal.
`results[].region`, `region_code`	string	División de primer nivel y su sufijo ISO 3166-2.
`results[].lat`, `lon`	number	El punto de la autoridad postal donde se publica; si no, el centroide de las direcciones del código.

Notas

Los códigos parciales funcionan donde el sistema del país es jerárquico: SW1A en el Reino Unido devuelve el distrito; 750 en Francia no devuelve nada, porque los códigos franceses no son prefijos.
Los países sin códigos postales (Irlanda antes del Eircode, varios de África y Oriente Medio) devuelven un array results vacío con status: ok.
Para una dirección completa con número de casa, usa la geocodificación directa; el código postal también le ayuda.

Errores

400 invalid_request cuando code está vacío o tiene más de 16 caracteres, o country no es un código alfa-2 válido.