curl "https://client.tukanmx.com/tukan-atlas/entity-types/" \
-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/entity-types/",
headers=headers,
)
resp.raise_for_status()
for t in resp.json()["results"]:
print(t["entity_type_id"], "-", t["name"])
{
"count": 9,
"page": 1,
"page_size": 100,
"results": [
{
"entity_type_id": "AGEB",
"name": "AGEB",
"name_en": "AGEB",
"description": "Área Geoestadística Básica definida por el INEGI, compuesta por un conjunto de manzanas delimitadas por calles, avenidas, vías de ferrocarril u otros rasgos geográficos.",
"description_en": "Basic Geostatistical Area defined by INEGI, composed of a group of blocks delimited by streets, avenues, railways or other geographic features."
},
{
"entity_type_id": "COUNTRY",
"name": "País",
"name_en": "Country",
"description": "División geográfica de nivel superior que representa una nación soberana.",
"description_en": "Top-level geographic division representing a sovereign nation."
}
]
}
Catálogos
Tipos de entidad
Los nueve niveles geográficos de Atlas y sus identificadores.
GET
/
entity-types
/
curl "https://client.tukanmx.com/tukan-atlas/entity-types/" \
-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/entity-types/",
headers=headers,
)
resp.raise_for_status()
for t in resp.json()["results"]:
print(t["entity_type_id"], "-", t["name"])
{
"count": 9,
"page": 1,
"page_size": 100,
"results": [
{
"entity_type_id": "AGEB",
"name": "AGEB",
"name_en": "AGEB",
"description": "Área Geoestadística Básica definida por el INEGI, compuesta por un conjunto de manzanas delimitadas por calles, avenidas, vías de ferrocarril u otros rasgos geográficos.",
"description_en": "Basic Geostatistical Area defined by INEGI, composed of a group of blocks delimited by streets, avenues, railways or other geographic features."
},
{
"entity_type_id": "COUNTRY",
"name": "País",
"name_en": "Country",
"description": "División geográfica de nivel superior que representa una nación soberana.",
"description_en": "Top-level geographic division representing a sovereign nation."
}
]
}
Los nueve niveles geográficos que maneja Atlas, con su nombre y su definición.
Los
entity_type_id de este catálogo (STATE, MUNICIPALITY, ZIPCODE…) son los valores que usas para filtrar en casi todos los demás endpoints.
curl "https://client.tukanmx.com/tukan-atlas/entity-types/" \
-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/entity-types/",
headers=headers,
)
resp.raise_for_status()
for t in resp.json()["results"]:
print(t["entity_type_id"], "-", t["name"])
{
"count": 9,
"page": 1,
"page_size": 100,
"results": [
{
"entity_type_id": "AGEB",
"name": "AGEB",
"name_en": "AGEB",
"description": "Área Geoestadística Básica definida por el INEGI, compuesta por un conjunto de manzanas delimitadas por calles, avenidas, vías de ferrocarril u otros rasgos geográficos.",
"description_en": "Basic Geostatistical Area defined by INEGI, composed of a group of blocks delimited by streets, avenues, railways or other geographic features."
},
{
"entity_type_id": "COUNTRY",
"name": "País",
"name_en": "Country",
"description": "División geográfica de nivel superior que representa una nación soberana.",
"description_en": "Top-level geographic division representing a sovereign nation."
}
]
}
Autorizaciones
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
Número de página
Resultados por página
Búsqueda global en entity_type_id, name y name_en
Ejemplo:
"estado"
ID exacto del tipo de entidad
Ejemplo:
"STATE"
Filtro por nombre en español (coincidencia parcial)
Ejemplo:
"municipio"
Filtro por nombre en inglés (coincidencia parcial)
Ejemplo:
"state"
¿Esta página le ayudó?