/v1/geo/zip-search
Encuentra los códigos postales de un lugar. Busca por estado, municipio y nombre de la colonia, por los primeros dígitos del código postal, o por cualquier combinación. Cada resultado es un asentamiento con su código postal. Se responde desde nuestra copia del Catálogo Nacional de Códigos Postales que publica Correos de México (SEPOMEX), en milisegundos.
Úsalo cuando tienes una dirección sin código postal, o para ofrecer las colonias de un municipio mientras alguien escribe.
Precios: gratis para usuarios con cualquier plan activo. Quienes pagan por uso (sin plan, solo saldo) pagan 1 crédito por llamada.
Cuerpo de la solicitud
Envía al menos uno de zip, municipality o settlement. state acota la búsqueda y no puede enviarse solo.
| Campo | Tipo | Descripción |
|---|---|---|
zip |
string | Los primeros dos a cinco dígitos del código postal ("664" encuentra del 66400 al 66499). |
state |
string | El nombre del estado, o cómo empieza: "Veracruz" encuentra Veracruz de Ignacio de la Llave. "Estado de México" y "CDMX" se entienden. Un nombre que no corresponde a ningún estado, o a más de uno, regresa 422. |
municipality |
string | Tres o más letras que aparezcan en cualquier parte del nombre del municipio ("san nicolas" encuentra San Nicolás de los Garza). |
settlement |
string | Tres o más letras que aparezcan en cualquier parte del nombre del asentamiento. |
limit |
integer | Cuántos resultados regresar, de 1 a 200. Por defecto, 50. |
Los nombres coinciden sin importar acentos ni mayúsculas: "juarez" encuentra Juárez.
Pruébalo
/v1/geo/zip-search
Inicia sesión para enviar una solicitud real desde esta página.
Las cuentas nuevas reciben $5 USD de crédito al registrarse, sin tarjeta.
Solicitud de ejemplo
curl -X POST https://mexcheck.com/v1/geo/zip-search \
-H "x-api-key: rfc_your_api_key" \
-H "Content-Type: application/json" \
-d '{"state": "Nuevo León", "municipality": "San Nicolás de los Garza", "settlement": "miraflores"}'
Respuesta (200)
{
"count": 1,
"truncated": false,
"results": [
{
"zip": "66410",
"settlement": "Miraflores",
"type": "Colonia",
"zone": "Urbano",
"municipality": "San Nicolás de los Garza",
"state": "Nuevo León"
}
]
}
| Campo | Descripción |
|---|---|
count |
Cuántos resultados trae esta respuesta. |
truncated |
true cuando coincidieron más asentamientos que limit. Acota la búsqueda o sube limit. |
results |
Los asentamientos que coinciden, ordenados por código postal y luego por nombre. Vacío cuando nada coincidió, lo que se cobra como cualquier otra respuesta. |
Errores
Una búsqueda que no se puede ejecutar regresa 422 con error invalid_fields y los campos con problema, y no se cobra: nada por qué buscar, un prefijo de código postal que no tiene de dos a cinco dígitos, un nombre de menos de tres letras, un estado desconocido o un limit fuera de 1 a 200.