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	Por defecto
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 geográficas	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: Metrópolis de México ciu: Ciudades autorrepresentadas	Todos los tipos de entidades geográficas
Contenido	what	Esta opción permite seleccionar qué 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 html: HTML	json

Diccionario de datos (salida)

Las columnas de la respuesta de la API dependen de la opción what especificada. A continuación, se listan las variables habituales en las respuestas estándar:

Nombre de la variable	Descripción
id	Identificador numérico único del indicador solicitado.
indicador	Nombre del indicador en texto plano.
geo_type	Tipo de unidad territorial de referencia (por ejemplo: edo, mun, met, ciu).
geo_id	Clave única de la unidad territorial correspondiente.
geo_nombre	Nombre de la unidad territorial.
sexo	Valor de referencia para el sexo de la población (por ejemplo: Total, Mujeres u Hombres).
year	Año de referencia del dato del indicador.
valor	Dato numérico del indicador en el periodo y territorio seleccionados.