Geography

List settlements for a municipality

Returns up to 1000 settlements (colonias). When the municipality has more than 1000, the response is truncated and truncated is true.

get/api/v1/{country}/municipio/{estado_slug}/{municipio_slug}

Request

  • Base URL: https://postali.app
  • URL: https://postali.app/api/v1/{country}/municipio/{estado_slug}/{municipio_slug}
  • Auth: none required

Path parameters

country'mx' | 'co' | 'es' required
Example:mx

ISO 3166-1 alpha-2 country code in lowercase. The path /api/v1/cp/... (without country) defaults to mx for backwards compatibility.

estado_slugstring required
Example:jalisco
municipio_slugstring required
Example:guadalajara

Response

Municipality details with settlements.

estadostring required
estado_slugstring required
municipiostring required
municipio_slugstring required
total_asentamientosinteger required
truncatedboolean required

True if there are more than 1000 settlements and the list was capped.

Changes

No recorded changes to this operation across all 1 revision of this API.