Polígonos

curl "https://client.tukanmx.com/tukan-atlas/polygons/detailed/?entity_type_id=MUNICIPALITY&entity_code=16053&valid_to=null" \
  -H "Authorization: Token $API_TUKAN"

import os
import requests

headers = {"Authorization": f"Token {os.environ['API_TUKAN']}"}

resp = requests.get(
    "https://client.tukanmx.com/tukan-atlas/polygons/detailed/",
    headers=headers,
    params={
        "entity_type_id": "MUNICIPALITY",
        "entity_code": "16053",
        "valid_to": "null",
    },
)
resp.raise_for_status()
p = resp.json()["results"][0]
print("centro:", p["centroid_lat"], p["centroid_lon"])

{
  "count": 1,
  "page": 1,
  "page_size": 100,
  "results": [
    {
      "polygon_code": "mex_municipality_16053_20250101",
      "entity_type_id": "MUNICIPALITY",
      "entity_code": "16053",
      "valid_from": "2025-01-01",
      "valid_to": null,
      "area_km2": 1184.81,
      "source_id": "MEX_INEGI",
      "bbox_west": -101.5089,
      "bbox_east": -101.0426,
      "bbox_south": 19.4472,
      "bbox_north": 19.8623,
      "centroid_lon": -101.2791,
      "centroid_lat": 19.6666
    }
  ]
}

GET

polygons

detailed

curl "https://client.tukanmx.com/tukan-atlas/polygons/detailed/?entity_type_id=MUNICIPALITY&entity_code=16053&valid_to=null" \
  -H "Authorization: Token $API_TUKAN"

import os
import requests

headers = {"Authorization": f"Token {os.environ['API_TUKAN']}"}

resp = requests.get(
    "https://client.tukanmx.com/tukan-atlas/polygons/detailed/",
    headers=headers,
    params={
        "entity_type_id": "MUNICIPALITY",
        "entity_code": "16053",
        "valid_to": "null",
    },
)
resp.raise_for_status()
p = resp.json()["results"][0]
print("centro:", p["centroid_lat"], p["centroid_lon"])

{
  "count": 1,
  "page": 1,
  "page_size": 100,
  "results": [
    {
      "polygon_code": "mex_municipality_16053_20250101",
      "entity_type_id": "MUNICIPALITY",
      "entity_code": "16053",
      "valid_from": "2025-01-01",
      "valid_to": null,
      "area_km2": 1184.81,
      "source_id": "MEX_INEGI",
      "bbox_west": -101.5089,
      "bbox_east": -101.0426,
      "bbox_south": 19.4472,
      "bbox_north": 19.8623,
      "centroid_lon": -101.2791,
      "centroid_lat": 19.6666
    }
  ]
}

Consulta el polígono de una entidad geográfica con su área en km², su bounding box y su centroide. Como los límites cambian con el tiempo, una misma entidad tiene varias versiones con su vigencia (valid_from y valid_to). La regla de oro es que valid_to en null es la versión vigente hoy, así que para casi cualquier análisis conviene filtrar ?valid_to=null. Con el bbox y el centroide resuelves los casos de mapa más comunes.

Centrar y hacer zoom, porque el bbox define el encuadre exacto de la entidad.
Colocar un marcador o etiqueta, usando el centroide como punto representativo.
Filtrar espacialmente, descartando entidades cuyo bbox ni siquiera intersecta tu área de interés antes de hacer cálculos finos.

La API no regresa la geometría completa del polígono. Si necesitas medir algo dentro de un área, manda tu propio polígono a estadísticas por polígono y Atlas calcula los indicadores por ti.

curl "https://client.tukanmx.com/tukan-atlas/polygons/detailed/?entity_type_id=MUNICIPALITY&entity_code=16053&valid_to=null" \
  -H "Authorization: Token $API_TUKAN"

import os
import requests

headers = {"Authorization": f"Token {os.environ['API_TUKAN']}"}

resp = requests.get(
    "https://client.tukanmx.com/tukan-atlas/polygons/detailed/",
    headers=headers,
    params={
        "entity_type_id": "MUNICIPALITY",
        "entity_code": "16053",
        "valid_to": "null",
    },
)
resp.raise_for_status()
p = resp.json()["results"][0]
print("centro:", p["centroid_lat"], p["centroid_lon"])

{
  "count": 1,
  "page": 1,
  "page_size": 100,
  "results": [
    {
      "polygon_code": "mex_municipality_16053_20250101",
      "entity_type_id": "MUNICIPALITY",
      "entity_code": "16053",
      "valid_from": "2025-01-01",
      "valid_to": null,
      "area_km2": 1184.81,
      "source_id": "MEX_INEGI",
      "bbox_west": -101.5089,
      "bbox_east": -101.0426,
      "bbox_south": 19.4472,
      "bbox_north": 19.8623,
      "centroid_lon": -101.2791,
      "centroid_lat": 19.6666
    }
  ]
}

Autorizaciones

Authorization

string

header

requerido

Token de autenticación. Formato requerido: Token tu-token (la palabra Token, un espacio y tu token). Solicita tu token escribiendo a contacto@tukanmx.com.

Parámetros de consulta

page

integer

predeterminado:1

Número de página

page_size

integer

predeterminado:100

Resultados por página

entity_type_id

enum<string>

Tipo de entidad geográfica del polígono

Opciones disponibles:

COUNTRY,

STATE,

MUNICIPALITY,

ZIPCODE,

LOCALITY,

AGEB,

URBAN_BLOCK,

RURAL_BLOCK,

NEIGHBORHOOD

Ejemplo:

"ZIPCODE"

entity_code

string

Código geográfico de la entidad (coincidencia exacta)

Ejemplo:

"16053"

polygon_code

string

Código único del polígono (coincidencia exacta)

Ejemplo:

"mex_municipality_16053_20250101"

source_id

string

Fuente del polígono (coincidencia exacta)

Ejemplo:

"MEX_INEGI"

valid_to

string

Fecha de expiración del polígono (YYYY-MM-DD). Usa null para filtrar solo polígonos vigentes.

Ejemplo:

null

valid_from

string<date>

Fecha de inicio de validez del polígono (YYYY-MM-DD)

Ejemplo:

"2020-01-01"

string

Búsqueda global en polygon_code y entity_code

Respuesta

Polígonos con detalle espacial obtenidos exitosamente

count

integer

page

integer

page_size

integer

results

object[]

Show child attributes

Estadísticas

Lugares

Pinpoint

Catálogos

Ejemplos y guías

Autorizaciones

Parámetros de consulta

Respuesta