Esta guía te proporcionará toda la información necesaria para interactuar con nuestros servicios de manera efectiva. A continuación, se explica la sintaxis general de las solicitudes a la API, seguida de una descripción detallada de las opciones disponibles.

Síntaxis general

La sintaxis general para realizar una solicitud a nuestra API es la siguiente:
/api/v1/indicators?token=[PONER TU TOKEN AQUI]&parametro1=valor1&parametro2=valor2

Opciones / parámetros

Concepto	Nombre del parámetro	Opciones	Default
API-Token	token	Para poder usar el servicio API, es necesario obtener un API-Token. El token le será enviado a su correo electrónico y se tiene que incluir en cada solicitud.	--
Indicador(es)	indicators	Selección de un indicador: indicar el ID del indicador. Ejemplo indicators=56 Múltiples indicadores: lista separada por | de los ID's de los indicadores: Ejemplo indicators=56|77|189 Todos los indicadores: default omitir la opción	Todos los indicadores
Año(s)	years	Selección de un año: indicar el año. Ejemplo years=2023 Múltiples años: lista separada por | los años: Ejemplo years=2005|2010|2020 Rango de años: para indicar de un año a otro, usar un guión Ejemplo years=2005-2020 Último año disponible: en caso de múltiples indicadores, puede variar el año en función del indicador. Ejemplo: years=latest Todos los años disponibles: default omitir la opción	Todos los años disponibles
Tipo de entidades geogŕaficas	geo	Selección de un tipo: indicar tipo Ejemplo geo=edo Múltiples indicadores: lista separada por | : Ejemplo geo=edo|ciu Todos los indicadores: default omitir la opción Valores disponibles: edo: Estados (Entidades federativas) mun: Municipios met: Zonas metropolitanas ciu: Ciudades autorrepresentadas	Todos los tipos de entidades geográficas
Contenido	what	Esta opción permite seleccionar que tipo de datos se quiere solicitar. Selección de un tipo: Ejemplo what=metadatos Valores disponibles: both: Códigos y etiquetas codes: Códigos labels: etiquetas metadatos: metadatos de los indicadores	both
Formato de salida	format	Se puede elegir entre varios formatos de salida. Selección de un tipo: Ejemplo format=csv Valores disponibles: json: (default) JSON para consumir directamente json_file: Un archivo JSON csv: CSV xlsx: Excel (xlsx) xml: XML	json

Variables de salida

El nombre de variables de salida depende de la opción what. Puede incluir: id indicador geo_type geo_id geo_nombre sexo year valor

Nombre de la Variable	Explicación
id	Identificador del indicador.
indicador	Nombre del indicador que se está consultando.
geo_type	Tipo de área geográfica. Posibles valores: edo: Estados (Entidades federativas) mun: Municipios met: Zonas metropolitanas ciu: Ciudades autorrepresentadas
geo_id	Identificador único de la área geográfica.
geo_nombre	Nombre de la área geográfica.
sexo	Género de la población a la que se refiere el indicador. Valores disponibles: Total: Ambos sexos o indicador que no se refiere a ningún sexo en particular. Mujeres: Indicador que se refiere únicamente a la población femenina. Hombres: Indicador que se refiere únicamente a la población masculina.
year	Año al que corresponde el dato del indicador.
valor	Valor del indicador.