GET
/v1/settlements?q={name}
Búsqueda de Colonia
Busca colonias por nombre parcial. Devuelve una lista paginada con contexto de municipio y estado.
Parámetros de Consulta
| Parámetro | Tipo | Descripción |
|---|---|---|
| q | string | Nombre parcial de colonia, mín. 2 caracteres. Ej. Polanco |
| page | integer | Número de página (20 resultados por página, predeterminado 1) |
Solicitud
curl -H "Authorization: Bearer YOUR_API_KEY" \ "https://api.postalkit.mx/v1/settlements?q=Polanco&page=1"
Respuesta
{
"data": [
{
"id": 8421,
"name": "Polanco I Sección",
"type": "Colonia",
"postal_code": "11510",
"municipality": "Miguel Hidalgo",
"state": "Ciudad de México"
}
],
"links": { "first": "...", "last": "...", "prev": null, "next": "..." },
"meta": { "current_page": 1, "total": 6, "per_page": 20 }
}