Geography

Get details of a single region

get/api/v1/{country}/estado/{slug}

Request

  • Base URL: https://postali.app
  • URL: https://postali.app/api/v1/{country}/estado/{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.

slugstring required
Example:jalisco

Response

Region details.

nombrestring required
slugstring required
total_asentamientosinteger required
total_municipiosinteger required

Example response

{
  "nombre": "Jalisco",
  "slug": "jalisco",
  "total_asentamientos": 6475,
  "total_municipios": 125
}

Changes

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