Saltar a los endpoints

06/2 endpoints

API de calles

Busca nombres de calles de México dentro de un estado y un municipio, acota los resultados a una localidad y consulta los tipos de vialidad oficiales. Estos endpoints están activos, pero el catálogo de calles que va detrás todavía no está cargado.

Todavía no hay datos detrás de este endpoint

Todos los endpoints de esta página están desplegados y responden, pero el catálogo que va detrás no está cargado, así que los resultados vuelven vacíos. Las formas de solicitud y respuesta de abajo son el contrato y no van a cambiar cuando lleguen los datos. Nada más de la API se ve afectado.

URL base https://api.postalkit.mx
Autenticación
GET /v1/streets

Buscar Calles

Busca calles dentro de un estado y municipio. Opcionalmente filtra por localidad y nombre de calle. Devuelve resultados paginados ordenados por nombre.

Parámetros de Consulta

Parámetro Tipo Descripción
state_code string Código INEGI del estado (requerido). Ej. 09
municipality_code string Código INEGI del municipio (requerido). Ej. 015
locality_code string Código INEGI de localidad opcional para reducir resultados
q string Búsqueda opcional de nombre de calle (coincidencia parcial)
limit integer Resultados por página (máx. 100, predeterminado 50)
page integer Número de página

Solicitud

curl
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.postalkit.mx/v1/streets?state_code=09&municipality_code=015&q=Reforma"

Respuesta

200 Éxito (paginado)
{
  "data": [
    {
      "id": 1,
      "name": "Reforma",
      "code": "0001",
      "ambito": "Urbano",
      "street_type": { "id": 1, "name": "Avenida", "code": "01" },
      "state": { "id": 1, "name": "Ciudad de México", "code": "09" },
      "municipality": { "id": 6, "name": "Cuauhtémoc", "code": "015" }
    }
  ],
  "links": { "first": "...", "last": "...", "prev": null, "next": null },
  "meta": { "current_page": 1, "total": 1, "per_page": 50 }
}
422 Error de Validación
{ "message": "The given data was invalid.", "errors": { "state_code": ["The \"state_code\" query parameter is required."] } }
GET /v1/street-types

Listar Tipos de Calle

Obtiene el catálogo completo de tipos de calle (ej. Avenida, Calle, Boulevard). Devuelve todos los tipos ordenados por nombre.

Solicitud

curl
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.postalkit.mx/v1/street-types

Respuesta

200 Éxito
{
  "data": [
    { "id": 1, "name": "Avenida", "code": "01" },
    { "id": 2, "name": "Boulevard", "code": "02" },
    { "id": 3, "name": "Calle", "code": "03" }
  ]
}

¿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"