Skip to main content
GET
Busca cualquier entidad geográfica de México por nombre, código o jerarquía. Es el endpoint que usas para resolver “¿cuál es el entity_id de Morelia?” antes de pedir observaciones. Los dos patrones más comunes son estos.
  • Resolver una entidad por nombre. Combina entity_type_id con name, como en ?entity_type_id=MUNICIPALITY&name=morelia.
  • Listar las hijas de una entidad. Usa parent_code, como en ?entity_type_id=MUNICIPALITY&parent_code=16, que regresa los 113 municipios de Michoacán.
Los filtros por campo tienen prioridad sobre search. Si mandas cualquier filtro (entity_type_id, name, parent_code…), el parámetro search se ignora por completo. Para acotar por tipo y nombre a la vez, usa entity_type_id + name, no entity_type_id + search.
Para saber qué entidades rodean a la que encontraste, usa entidades vecinas. Para sus indicadores, como población, nivel socioeconómico o precios, pásale el entity_id a últimas observaciones.

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

Búsqueda global en entity_code, name, name_en y parent_code

Ejemplo:

"morelia"

entity_code
string

Código geográfico exacto de la entidad

Ejemplo:

"16053"

entity_type_id
enum<string>

Tipo de entidad geográfica (coincidencia exacta)

Opciones disponibles:
COUNTRY,
STATE,
MUNICIPALITY,
ZIPCODE,
LOCALITY,
AGEB,
URBAN_BLOCK,
RURAL_BLOCK,
NEIGHBORHOOD
Ejemplo:

"MUNICIPALITY"

name
string

Filtro por nombre en español (coincidencia parcial)

Ejemplo:

"morelia"

name_en
string

Filtro por nombre en inglés (coincidencia parcial)

Ejemplo:

"méxico city"

parent_code
string

Código de la entidad padre (coincidencia exacta). Útil para listar todos los municipios de un estado.

Ejemplo:

"09"

Respuesta

Entidades geográficas obtenidas exitosamente

count
integer
page
integer
page_size
integer
results
object[]