Saltar a los endpoints

04/2 endpoints

API de municipios

Obtén todos los códigos postales y todas las colonias de un municipio de México, identificado por su ID.

URL base https://api.postalkit.mx
Autenticación
GET /v1/municipalities/{id}/postal-codes

Listar Códigos Postales por Municipio

Devuelve todos los códigos postales que pertenecen al municipio dado, ordenados por código y paginados con 20 resultados por página.

Parámetros de URL

Parámetro Tipo Descripción
id integer ID numérico del municipio

Solicitud

curl
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.postalkit.mx/v1/municipalities/6/postal-codes

Respuesta

200 Éxito (paginado)
{
  "data": [
    {
      "id": 384,
      "code": "06600",
      "state": { "id": 1, "name": "Ciudad de México", "code": "09" },
      "municipality": { "id": 6, "name": "Cuauhtémoc", "code": "015" },
      "city": { "id": 1, "name": "Ciudad de México" }
    }
  ],
  "links": { "first": "...", "last": "...", "prev": null, "next": "..." },
  "meta": { "current_page": 1, "total": 71, "per_page": 20 }
}
404 No Encontrado
{ "message": "Municipality with id 999 not found." }
GET /v1/municipalities/{id}/settlements

Listar Colonias por Municipio

Devuelve todas las colonias que pertenecen al municipio dado, ordenadas alfabéticamente y paginadas con 20 resultados por página.

Parámetros de URL

Parámetro Tipo Descripción
id integer ID numérico del municipio

Solicitud

curl
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.postalkit.mx/v1/municipalities/6/settlements

Respuesta

200 Éxito (paginado)
{
  "data": [
    {
      "id": 532,
      "name": "Juárez",
      "zone": "Urbano",
      "settlement_type": { "id": 1, "name": "Colonia" },
      "postal_code": { "id": 384, "code": "06600" }
    }
  ],
  "links": { "first": "...", "last": "...", "prev": null, "next": "..." },
  "meta": { "current_page": 1, "total": 230, "per_page": 20 }
}
404 No Encontrado
{ "message": "Municipality with id 999 not found." }

¿Listo para construir?

Comienza a consultar el catálogo postal completo en minutos.

curl -s https://api.postalkit.mx/v1/postal-codes/06600 -H "Authorization: Bearer YOUR_API_KEY"