Saltar al contenido principal
GET
/
zipcodes
Catálogo
curl --request GET \
  --url https://entities.tukanmx.com/api/v1/zipcodes \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "total_count": 123,
  "total_pages": 123,
  "current_page": 123,
  "limit": 123,
  "offset": 123,
  "has_next": true,
  "has_previous": true,
  "next_offset": 123,
  "previous_offset": 123,
  "data": [
    {
      "id": "<string>",
      "zip_code": "<string>",
      "country_id": "<string>",
      "country": "<string>",
      "state_id": "<string>",
      "state_name": "<string>",
      "municipality_id": "<string>",
      "municipality_name": "<string>",
      "population": 123,
      "inhabited_households": 123,
      "nse_predominant_level": "<string>",
      "neighborhoods": [
        "<string>"
      ],
      "bbox_east": 123,
      "bbox_north": 123,
      "bbox_south": 123,
      "bbox_west": 123,
      "area_km2": 123,
      "centroid_lat": 123,
      "centroid_lon": 123,
      "neighbors": [
        "<string>"
      ],
      "state_border": true,
      "data_coverage": {
        "demographic": 10,
        "education": 5,
        "employment": 8,
        "health": 4,
        "housing": 7,
        "socioeconomic": 6
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Token para autenticación. Formato requerido: token

Query Parameters

state_id
string

ID del estado (2 dígitos). Puede ser uno o varios separados por comas

Example:

"09,15,18"

municipality_id
string

ID del municipio (5 dígitos). Puede ser uno o varios separados por comas

Example:

"09015,15033"

limit
integer
default:100

Número de registros a retornar (máximo 2,000)

Rango requerido: 1 <= x <= 2000
offset
integer
default:0

Número de registros a omitir para paginación

Rango requerido: x >= 0

Response

Lista de códigos postales obtenida exitosamente

count
integer

Número de resultados en esta página

total_count
integer

Total de códigos postales disponibles

total_pages
integer

Número total de páginas

current_page
integer

Página actual

limit
integer

Resultados por página

offset
integer

Desplazamiento actual

has_next
boolean

Indica si hay página siguiente

has_previous
boolean

Indica si hay página anterior

next_offset
integer

Desplazamiento para la siguiente página

previous_offset
integer

Desplazamiento para la página anterior

data
object[]