Búsqueda - Documentación Tukan

Búsqueda

curl --request GET \
  --url https://entities.tukanmx.com/api/v1/zipcodes/search \
  --header 'Authorization: <api-key>'

{
  "count": 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
      }
    }
  ]
}

GET

zipcodes

Búsqueda

curl --request GET \
  --url https://entities.tukanmx.com/api/v1/zipcodes/search \
  --header 'Authorization: <api-key>'

{
  "count": 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

zip_codes

string

required

Códigos postales a buscar (5 dígitos), separados por comas. Máximo 20 códigos

Example:

"01000,01010,01020"

Response

Códigos postales encontrados exitosamente

count

integer

Número de resultados

data

object[]

Mostrar atributos secundarios

data.id

string

Identificador único del código postal

data.zip_code

string

Código postal de 5 dígitos

data.country_id

string

ID del país

data.country

string

Nombre del país

data.state_id

string

ID del estado (2 dígitos)

data.state_name

string

Nombre del estado

data.municipality_id

string

ID del municipio (5 dígitos)

data.municipality_name

string

Nombre del municipio

data.population

integer | null

Población total. Si es nulo, no hay datos disponibles

data.inhabited_households

integer | null

Viviendas habitadas. Si es nulo, no hay datos disponibles

data.nse_predominant_level

string | null

Nivel socioeconómico predominante. Si es nulo, no hay datos disponibles

data.neighborhoods

string[]

Lista de colonias/barrios, clasificados por tipo de barrio y urbanización

data.bbox_east

number<float> | null

Punto más al este del código postal. Si es nulo, no se tiene polígono para este código postal

data.bbox_north

number<float> | null

Límite más al norte del código postal. Si es nulo, no se tiene polígono para este código postal

data.bbox_south

number<float> | null

Límite más al sur del código postal. Si es nulo, no se tiene polígono para este código postal

data.bbox_west

number<float> | null

Punto más al oeste del código postal. Si es nulo, no se tiene polígono para este código postal

data.area_km2

number<float> | null

Área en kilómetros cuadrados. Si es nulo, no se tiene polígono para este código postal

data.centroid_lat

number<float> | null

Latitud del centroide. Si es nulo, no se tiene polígono para este código postal

data.centroid_lon

number<float> | null

Longitud del centroide. Si es nulo, no se tiene polígono para este código postal

data.neighbors

string[]

Lista de códigos postales vecinos

data.state_border

boolean | null

Indica si el código postal está en frontera estatal. Si es nulo, no se tiene polígono para este código postal

data.data_coverage

object

Cobertura de datos disponibles para este código postal.

Indica qué tipos de información están disponibles y su nivel de completitud.

Si la propiedad no está presente, significa que no hay datos disponibles para este código postal en esa categoría.

Mostrar atributos secundarios

data.data_coverage.demographic

integer

Indica cuantos indicadores demográficos hay disponibles para este código postal

data.data_coverage.education

integer

Indica cuantos indicadores de educación hay disponibles para este código postal

data.data_coverage.employment

integer

Indica cuantos indicadores de empleo hay disponibles para este código postal

data.data_coverage.health

integer

Indica cuantos indicadores de salud hay disponibles para este código postal

data.data_coverage.housing

integer

Indica cuantos indicadores de vivienda hay disponibles para este código postal

data.data_coverage.socioeconomic

integer

Indica cuantos indicadores socioeconómicos hay disponibles para este código postal

Example:

{
  "demographic": 10,
  "education": 5,
  "employment": 8,
  "health": 4,
  "housing": 7,
  "socioeconomic": 6
}

Catálogo Datos

⌘I