API del Banco de Indicadores

Esta documentación está dirigida para los desarrolladores familiarizados con la programación JavaScript y conocimientos de programación orientada a objetos.

Métodos para obtener información a través de la API

Indicadores
Cátalogo de metadatos

Método Indicadores

Para consultar el método Indicadores se envían los parámetros directamente en la URL, por ejemplo:

Sintaxis:

https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/INDICATOR/[IdIndicador]/[Idioma]/[Área Geográfica]/[Recientes]/[Fuente de datos]/[Versión][Token]?type=[Formato]

URL:

https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/INDICATOR/1002000001/es/00/true/BISE/2.0/[Aquí va tu Token]?type=json

IdIndicador El primer paso que se debe realizar para obtener información de la API es seleccionar el indicador e identificar su clave. Esto lo puede realizar consultando el "Constructor de consultas".

Idioma: La información está disponible en español [es] en inglés [en].

Área geográfica: Puede ser nacional [00], por entidad federativa [99] o por municipio [999], dependiendo de cada indicador.

Dato más reciente o Serie histórica: Puede consultarse solo el dato más reciente [true] o la serie histórica completa [false].

Fuente de datos: Corresponde a la fuente de diseminación [BISE] o [BIE-BISE] de donde se obtendrán los datos consultados.

Versión: Con él se identificará la edición [2.0] del servicio de provisión de datos.

Token: Para utilizar la API es necesario mandarle un token válido, el cual puede obtener al registrarse aquí .

Formato: Se ofrece la información en 5 tipos de formatos: JSON [json], JSONP [jsonp], XML [xml], PC-Axis[pcAxis] y Json-Stat[jsonStat]. PC-Axis es un programa estadístico especializado con un estándar en cuanto a la difusión de datos; mientras que JSON-stat es más ligero y simple que el JSON, adecuado para visualización de datos, aplicaciones móviles o iniciativas de datos abiertos.

 {"Header":{"Name":"Datos compactos BISE","Email":"atencion.usuarios@inegi.org.mx"},"Series":[{"INDICADOR":"1002000001","FREQ":"7","TOPIC":"123","UNIT":"188","UNIT_MULT":"","NOTE":"1398","SOURCE":"2,3,343,487,781,1668,1669,1670,1671,1672,1677,1678,1679,1714,3001","LASTUPDATE":"21/10/2024 12:00:00 a. m.","STATUS":null,"OBSERVATIONS":[{"TIME_PERIOD":"2020","OBS_VALUE":"126014024.00000000000000000000","OBS_EXCEPTION":null,"OBS_STATUS":"3","OBS_SOURCE":"","OBS_NOTE":"","COBER_GEO":"0"}]}]}

A continuación se explica el orden de los valores devueltos

Header

Name: Nombre de la estructura.

Email: Correo electrónico del instituto.

Serie

INDICADOR: Identificador único del indicador.

FREQ: Periodicidad de actualización de la información.

TOPIC: Identificador del tema.

UNIT: Unidad de medida.

UNIT_MULT: Unidad multiplicadora del indicador.

NOTE: Notas relacionadas al indicador.

SOURCE: Fuente o programa del indicador.

LASTUPDATE: Fecha de actualización del indicador.

STATUS: Estatus del indicador.

OBSERVATIONS

TIME_PERIOD: Periodo de la observación.

OBS_VALUE: Valor de la observación.

OBS_EXCEPTION: Excepción cuando no existe un valor.

OBS_STATUS: Estatus de la observación.

OBS_SOURCE: Fuente o programa relacionada la observación.

OBS_NOTE: Notas relacionada a la observación.

COBER_GEO: Clave de área geográfica.

Método Catálogo de metadatos

Para consultar el método Catálogo de metadatos se envían los parámetros directamente en la URL, por ejemplo:

Sintaxis:

https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/[Catalogo]/[IdCatalogo]/[Idioma]/[Fuente de datos]/[Token]?type=[Formato]

URL:

https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/CL_STATUS/null/es/BISE/2.0/[Aquí va tu Token]?type=json

Catálogo: Identifica [CL_UNIT] al listado de datos que complementan al indicador. Esto lo puede realizar consultando el "Constructor de consultas".

IdCatalogo: Llave de identificación para obtener un registro [1] o todos [null] los registros del catálogo.

Idioma: La información está disponible en español [es] e inglés [en].

Fuente de datos: Corresponde a la fuente de diseminación [BISE] o [BIE-BISE] de donde se obtendrán los datos consultados.

Versión: Con él se identificará la edición [2.0] del servicio de provisión de datos.

Token: Para utilizar la API es necesario mandarle un token válido, el cual puede obtener al registrarse aquí .

Formato: Se ofrece la información en 3 tipos de formatos: JSON [json], JSONP [jsonp] o XML [xml].

{"id":"CL_STATUS","agencyID":"INEGI","version":"1.0","lang":"es","CODE":[{"value":"1","Description":"Preliminar"},{"value":"2","Description":"Revisada"},{"value":"3","Description":"Definitiva"},{"value":"4","Description":"Estimada"},{"value":"6","Description":"Oportuna"},{"value":"7","Description":"Corregida"},{"value":"8","Description":"Ajustada"}]}

Id: Es el identificador del método seleccionado["INDICATOR"].

AgencyID: Es la identificación de la agencia que proporciona los datos["INEGI"].

Lang: Es la clave del idioma en la que otorgan los datos["es"].

CODE: Es el arreglo de los datos obtenidos, cada elemento consta de los siguientes atributos.

Value: Es un identificador del dato.

Description: Es la descripción del dato.

Ejemplos de uso de la API

Obtener datos de la serie histórica del indicador de Población total, en los Estados Unidos Mexicanos, en idioma español, en formato JSON
Obtener datos de la serie histórica del indicador de Población total, en los Estados Unidos Mexicanos, en idioma español, en formato JSON y calcular su promedio
Obtener datos de la serie histórica del indicador de Población total, en los Estados Unidos Mexicanos, en idioma español, en formato PC-Axis
Obtener datos de la serie histórica del indicador de Población total, en los Estados Unidos Mexicanos, en idioma español, en formato Json-Stat

Obtener datos de la serie histórica del indicador de Población total, en los Estados Unidos Mexicanos, en idioma español, en formato JSON

Enseguida se muestra un ejemplo para presentar la información en una página web en forma de gráfica.

<!DOCTYPE html >
<html xmlns="http://www.w3.org/1999/xhtml">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
        <title ></title >
        <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
        <script type="text/javascript" src="js/llamarAPI.js"></script>
        <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script></head >
    <body >
        <div id="chart" style="width: 100%; min-height: 550px;"></div >
        <div id="NoteChart"></div >
        <div id="FuenteChart"></div >
    </body >
</html >

google.charts.load('current',{"packages": ['corechart', 'bar']});
google.charts.setOnLoadCallback(drawChart); var arrayChartData=[];

//Obetencion de la estructura de datos del indicador con los parametros
//Clave: 1002000002
//Idioma: es
//Clave entidad: 01
//Datos resientes: false
//Fuente de datos: BISE
//Versión: 2.0
var urlDataStructure="https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/INDICATOR/1002000001/es/00/false/BISE/2.0/[Aquí va tu Token]?type=json";
$.getJSON(urlDataStructure, function (dataStructure){
    var Observations=dataStructure.Series[0].OBSERVATIONS;
    for (var i=0; i <=Observations.length - 1; i++)
        {arrayChartData[i]=[Observations[i].TIME_PERIOD, parseInt(Observations[i].OBS_VALUE), '#E16c32'];}
});

//Obetencion de metadatos del indicador con los parametros
//Catalago: CL_INDICATOR
//Clave: 1002000002
//Idioma: es
//Fuente de datos: BISE
//Versión: 2.0
var dataCL_INDICATOR;
var urlDataCL_INDICATOR="https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/CL_INDICATOR/1002000001/es/BISE/2.0/[Aquí va tu Token]?type=json";
$.getJSON(urlDataCL_INDICATOR, function (dataCatalog){
    dataCL_INDICATOR={Descripcion: dataCatalog.CODE[0].Description, AgencyID: dataCatalog.agencyID,}
});

//Obetencion de la unidadde medida del indicador con los parametros
//Catalago: CL_UNIT //Clave: 96
//Idioma: es //Fuente de datos: BISE
//Versión: 2.0
var dataCL_UNIT;
var urlDataCL_UNIT="https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/CL_UNIT/96/es/BISE/2.0/[Aquí va tu Token]?type=json";
$.getJSON(urlDataCL_UNIT, function (dataCatalog){
    dataCL_UNIT={Descripcion: dataCatalog.CODE[0].Description, Value: dataCatalog.CODE[0].value,}
});

//Obetencion de la nota del indicador con los parametros
//Catalago: CL_NOTE
//Clave: 1398
//Idioma: es
//Fuente de datos: BISE
//Versión: 2.0
var dataCL_NOTE;
var urlDataCL_NOTE="https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/CL_NOTE/1398/es/BISE/2.0/[Aquí va tu Token]?type=json";
$.getJSON(urlDataCL_NOTE, function (dataCatalog){
    dataCL_NOTE={Descripcion: dataCatalog.CODE[0].Description, Value: dataCatalog.CODE[0].value,}
});

//Obetencion de la fuente del indicador con los parametros
//Catalago: CL_SOURCE
//Clave: 2,3,343,487,510
//Idioma: es
//Fuente de datos: BISE
//Versión: 2.0
var dataCL_SOURCE;
var urlDataCL_SOURCE="https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/CL_SOURCE/2,3,343,487,510/es/BISE/2.0/[Aquí va tu Token]?type=json";
$.getJSON(urlDataCL_SOURCE, function (dataCatalog){
    var descripcion=""; var value="";
    for (var i=0; dataCatalog.CODE.length >i; i++){
        descripcion=descripcion + " " + dataCatalog.CODE[i].Description; value=value + " " + dataCatalog.CODE[i].value;
    }
    dataCL_SOURCE={Descripcion: descripcion, Value: value,}
});

//Obetencion del tema del indicador con los parametros
//Catalago: CL_TOPIC
//Clave: 2,3,343,487,510
//Idioma: es
//Fuente de datos: BISE
//Versión: 2.0
var dataCL_TOPIC;
var urlDataCL_TOPIC="https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/CL_TOPIC/2,3,343,487,510/es/BISE/2.0/[Aquí va tu Token]?type=json";
$.getJSON(urlDataCL_SOURCE, function (dataCatalog){
    var descripcion=""; var value="";
    for (var i=0; dataCatalog.CODE.length >i; i++)
    {
        descripcion=descripcion + " " + dataCatalog.CODE[i].Description; value=value + " " + dataCatalog.CODE[i].value;
    }
    dataCL_SOURCE={Descripcion: descripcion, Value: value,}
});

//Obetencion de la frecuancia o periodicidad del indicador con los parametros
//Catalago: CL_FREQ
//Clave: 2,3,343,487,510
//Idioma: es
//Fuente de datos: BISE
//Versión: 2.0
var dataCL_FREQ;
var urlDataCL_FREQ="https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/CL_FREQ/7/es/BISE/2.0/[Aquí va tu Token]?type=json";
$.getJSON(urlDataCL_FREQ, function (dataCatalog){
    var descripcion="";
    var value="";
    dataCL_FREQ={Descripcion: dataCatalog.CODE[0].Description, Value: dataCatalog.CODE[0].value,}
});

//Obetencion de la entidado municipio del indicador con los parametros
//Catalago: CL_GEO_AREA
//Clave: 00
//Idioma: es
//Fuente de datos: BISE
//Versión: 2.0
var dataCL_GEO_AREA; var urlDataCL_GEO_AREA="https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/CL_GEO_AREA/00/es/BISE/2.0/[Aquí va tu Token]?type=json";
$.getJSON(urlDataCL_GEO_AREA, function (dataCatalog){
    var descripcion="";
    var value="";
    dataCL_GEO_AREA={Descripcion: dataCatalog.CODE[0].Description, Value: dataCatalog.CODE[0].value,}
});

//Funcion para pintar la grafica
function drawChart(){
    document.getElementById("NoteChart").innerHTML='<b >Nota </b ><br >' + dataCL_NOTE.Descripcion;
    document.getElementById("FuenteChart").innerHTML='<b >Fuente </b ><br >' + dataCL_SOURCE.Descripcion;

    var data=google.visualization.arrayToDataTable([[{role: "domain",
        Label: "Año",
        type: "string"},
        {
            Label: "Valor",
            role: "data",
            type: "number"
        },
        {role: "style"}]]);

    data.addRows(arrayChartData);

    var view=new google.visualization.DataView(data);

    var options={
        title:dataCL_INDICATOR.Descripcion + " (Periodicidad:" + dataCL_FREQ.Descripcion +", Área geográfica: "+dataCL_GEO_AREA.Descripcion+")",
        titleTextStyle:{
            fontSize: 14,
            color: 'black',
            bold: true,
            italic: false
        },
        chart:{
            title: 'Company Performance',
            subtitle: 'Sales, Expenses, and Profit: 2014-2017',
        },
        legend:{position: "none"},
        hAxis:{
            title: 'Años',
            format: 'yyyy',
            textStyle:{
                fontSize: 12,
                color: 'Black',
                bold: true,
                italic: false
            },
            titleTextStyle:{
                fontSize: 12,
                color: 'Black',
                bold: true,
                italic: false
            }
        },
        vAxis:{
            title: dataCL_UNIT.Descripcion,
            min:1,
            textStyle:{
                fontSize: 12,
                color: 'Black',
                bold: false,
                italic: false,
            },
            titleTextStyle:{
                fontSize: 12,
                color: 'Black',
                bold: true,
                italic: false
            }
        }
    };

    var chart=new google.visualization.ColumnChart(document.getElementById('chart'));
    chart.draw(view, options);
}

$(window).resize(function (){drawChart();});

Python

Obtener datos de la serie histórica del indicador de Población total, en los Estados Unidos Mexicanos, en idioma español, en formato JSON y calcular su promedio.

import requests
import json

#Llamado al API
url='https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/INDICATOR/1002000002/es/00000/false/BISE/2.0/[Aquí va tu Token]?type=json'
response= requests.get(url)
if response.status_code==200:
    content= json.loads(response.content)
    Series=content['Series'][0]['OBSERVATIONS']   
    
    #Obtención de la lista de observaciones 
    Observaciones=[]
    for obs in Series:  Observaciones.append(float(obs['OBS_VALUE']));
    

    #Generación del promedio de la lista de observaciones 
    sum=0.0
    for i in range(0,len(Observaciones)): sum=sum+Observaciones[i];  

    resultado=sum/len(Observaciones);
    print(resultado)

R

Obtener datos de la serie histórica del indicador de Población total, en los Estados Unidos Mexicanos, en idioma español, en formato JSON y calcular su promedio.

library(httr)
library(jsonlite)
library(rjson)

#Llamado al API
url <-"https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/INDICATOR/1002000001/es/00000/false/BISE/2.0/[Aquí va tu Token]?type=json"
respuesta<-GET(url)
datosGenerales<-content(respuesta,"text")
flujoDatos<-paste(datosGenerales,collapse = " ")

#Obtención de la lista de observaciones 
flujoDatos<-fromJSON(flujoDatos)
flujoDatos<-flujoDatos $Series
flujoDatos<-flujoDatos[[1]] $OBSERVATIONS

#Generación del promedio de la lista de observaciones 
datos<-0;
for (i in 1:length(flujoDatos)){

 datos[i]<-flujoDatos[[i]] $OBS_VALUE
}

datos<-as.numeric(datos)
print(mean(datos))

PC-Axis

Obtener datos de la serie histórica del indicador de Población total, en los Estados Unidos Mexicanos, en idioma español, en formato PC-Axis.

Parámetros de entrada:

Indicador: 1002000001
Área geográfica: 01
Idioma: es
Dato más reciente: False (para este caso se solicita la serie histórica completa)
Formato: pcAxis
Token: [Aquí va tu Token]

Consulta:
https://inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/PCAXIS/1002000001/es/00/false/BISE/[Aquí va tu Token]?type=pcAxis

Resultado:

 CHARSET="ANSI";
AXIS-VERSION="2010";
LANGUAGE="es";
CREATION-DATE="08/09/2026 02:48:35 p. m.";
DECIMALS=5;
SHOWDECIMALS=5;
MATRIX="BISE";
SUBJECT-CODE=" ";
SUBJECT-AREA=" ";
TITLE=" ";
CONTENTS=" ";
STUB="Indicador","Área geográfica","Unidad de medida";
HEADING="Periodo";
VALUES("Indicador")="Población total";
CODES("Indicador")="1002000001";
VALUES("Área geográfica")="Estados Unidos Mexicanos","Aguascalientes","Baja California","Baja California Sur","Campeche","Coahuila de Zaragoza","Colima","Chiapas","Chihuahua","Ciudad de México","Durango","Guanajuato","Guerrero","Hidalgo","Jalisco","México","Michoacán de Ocampo","Morelos","Nayarit","Nuevo León","Oaxaca","Puebla","Querétaro","Quintana Roo","San Luis Potosí","Sinaloa","Sonora","Tabasco","Tamaulipas","Tlaxcala","Veracruz de Ignacio de la Llave","Yucatán","Zacatecas","Otros estados","Extranjero","No especificada";
CODES("Área geográfica")="0","01","02","03","04","05","06","07","08","09","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","35","36","39";
VALUES("Periodo")="A 2020","A 2015","A 2010","A 2005","A 2000","A 1995","A 1990","A 1980","A 1970","A 1960","A 1950","A 1940","A 1930","A 1921","A 1910";
TIMEVAL("Periodo")=TLIST(A1),"A 1910","A 1921","A 1930","A 1940","A 1950","A 1960","A 1970","A 1980","A 1990","A 1995","A 2000","A 2005","A 2010","A 2015","A 2020";
VALUES("Unidad de medida")="Personas";
CODES("Unidad de medida")="188";
UNITS=" ";
DATASYMBOL1="NA";
DATASYMBOL2="NA";
DATASYMBOL3="NA";
DATASYMBOL4="NA";
NOTE="#"
"Nota:#
Esta información se actualiza cada cinco años mediante los Censos y Conteos de población y vivienda.#
Fuente:#
Censos y Conteos de Población y Vivienda 2000#
Censos y Conteos de Población y Vivienda 2005#
Censos y Conteos de Población y Vivienda 1995#
Censos y Conteos de Población y Vivienda 2010#
Censos y Conteos de Población y Vivienda 1990#
Censos y Conteos de Población y Vivienda 1980#
Censos y Conteos de Población y Vivienda 1970#
Censos y Conteos de Población y Vivienda 1960#
Censos y Conteos de Población y Vivienda 1950#
Censos y Conteos de Población y Vivienda 1940#
Censos y Conteos de Población y Vivienda 1930#
Censos y Conteos de Población y Vivienda 1921#
Censos y Conteos de Población y Vivienda 1910#
Encuesta Intercensal 2015#
Censos y Conteos de Población y Vivienda 2020#";
DESCRIPTIONDEFAULT=NO;
DATA=
126014024.00000000000000000000 119938473.00000000000000000000 112336538.00000000000000000000 103263388.00000000000000000000 97483412.00000000000000000000 91158290.00000000000000000000 81249645.00000000000000000000 66846833.00000000000000000000 48225238.00000000000000000000 34923129.00000000000000000000 25791017.00000000000000000000 19653552.00000000000000000000 16552722.00000000000000000000 14334780.00000000000000000000 15160369.00000000000000000000

Código

<!DOCTYPE html >    
<html>
<head>
    <link href="c3/c3.css" rel="stylesheet" type="text/css">
</head>
<body>
    <div id="chart"></div>
    <div id="chartPcAxis"></div>

    <script src="https://d3js.org/d3.v5.min.js" charset="utf-8"></script>
    <script src="c3/c3.js"></script>
    <script src="https://code.jquery.com/jquery-3.5.1.min.js"></script>

    <script src="JSPc-Axis/px.js"></script>
    <script src="JSPc-Axis/underscore.js"></script>;       
        
    </body >
</html >

window.onload = function() {
    getPcAxis();
}

function buildPcAxis() {
    return new Promise(function(resolve, reject) {
        var urlApiPcAxis = "http://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/PCAXIS/1002000001/es/00/false/BISE/[Aquí va tu Token]?type=pcAxis";
        $.ajax({
            type: "GET",
            url: urlApiPcAxis,
            //async: false,
            headers: {
                Accept: "text/px"
            },
            success: function(data, status, jqXHR) {
                resolve(data);
            },
            error: function(jqXHR, status) {
                reject(jqXHR);
            }
        });
    })
}

function buildChart(px) {

    const _column = [px.metadata["VALUES "].Indicadores];
    for (var i = 0; i < px.data.length; i++) {
        _column.push(parseFloat(px.data[i]))
    }

    const _X = ["x"];
    for (var i = 0; i < px.metadata["VALUES "].Tiempo.length; i++) {
        _X.push(px.metadata["VALUES "].Tiempo[i]);
    }

    var chartPcAxis = c3.generate({
        bindto: '#chartPcAxis',
        data: {
            x: 'x',
            colors: {
                '(1002000001) Población total': '#FF9124'
            },
            columns: [
                _X,
                _column
            ],
            type: 'bar',
            onclick: function(d, element) {
                //console.log("onclick", d, element);
            },
            onmouseover: function(d) {
                //console.log("onmouseover", d);
            },
            onmouseout: function(d) {
                //console.log("onmouseout", d);
            }
        },
        axis: {
            x: {
                type: 'categorized',
                label: 'X Label'
            },
            y: {
                label: {
                    text: px.metadata.UNITS.TABLE,
                    position: 'outer-middle'
                }
            }
        },
        bar: {
            width: {
                ratio: 0.3,
                //max: 30
            },
        }
    });
}

function getPcAxis() {
    buildPcAxis().then(r => {
        buildChart(new Px(r));
    }).catch(() => {
        console.log('Algo salió mal');
    });
}

Json-Stat

Obtener datos de la serie histórica del indicador de Población total, en los Estados Unidos Mexicanos, en idioma español, en formato Json-Stat.

Parámetros de entrada:

Indicador: 1002000001
Área geográfica 01
Idioma: es
Dato más reciente: False (para este caso se solicita la serie histórica completa)
Formato: jsonStat
Token: [Aquí va tu Token]

Consulta:
https://www.inegi.org.mx/app/api/indicadores/desarrolladores/jsonxml/JSONSTAT/1002000001/es/00/false/BISE/[Aquí va tu Token]?type=jsonStat

Resultado:

{"id":"CL_INDICATOR","agencyID":"INEGI","version":"1.0","lang":"es","CODE":[{"value":"1002000001","Description":"Población total"}]}

Código

<!DOCTYPE html >    
<html>
<head>
    
     <script src="//ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"> </script>
     <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/morris.js/0.5.1/morris.css">
     <script src="//cdnjs.cloudflare.com/ajax/libs/raphael/2.1.0/raphael-min.js"> </script>
     <script src="//cdnjs.cloudflare.com/ajax/libs/morris.js/0.5.1/morris.min.js"> </script>
</head>
<body>    
    <div id="barCharJsonStat"></div>
        
    </body>
</html>

/*
   JSON-stat JS Sample Code
   http://json-stat.org/tools/js.txt
   Author: Xavier Badosa (http://xavierbadosa.com)
   Date: 2015-12-22
   Version: 1.0.1

   Copyright 2015 Xavier Badosa
   License: Apache License, Version 2.0 http://www.apache.org/licenses/LICENSE-2.0
*/

var query = {
    "CL_GEO_AREA": "",
    "INDICADOR": "",
    "TIME_PERIOD": ""
};

var arrayCharMorisArray = [];

window.onload = function() {
    inicio();
}

function inicio() {

    getJsonStat().then(r => {
        console.log(r)
        main(r);
    }).catch(() => {
        console.log('Algo salió mal');
    });
}

function main(obj) {

    //Validate jsonstat
    var jsonstat = JSONstat(obj);

    if (!jsonstat) {
        return;
    }

    var timeline = Object.keys(obj.dimension.TIME_PERIOD.category.index);
    console.log(timeline);

    for (var i = 0; i <= timeline.length - 1; i++) {

        query.CL_GEO_AREA = "0700";
        query.INDICADOR = "1002000002";
        query.TIME_PERIOD = timeline[i];

        //Parse: Get value from jsonstat and query
        var value = getValue(jsonstat, query);

        //Write: Display query and result
        // show(query, value);

        addCharMorisArray(query, value);
    }

    arrayCharMorisArray;
    buidChatBarMoris(arrayCharMorisArray)
}

// Obtencion de los dastos en formato JsonStat
function getJsonStat() {

    return new Promise(function(resolve, reject) {

        var urlApiPcAxis = "/app/api/indicadores/desarrolladores/jsonxml/JSONSTAT/1002000002/es/0700/false/BISE/96fbd1bf-21e6-28e3-6e64-2b15999d2c89?type=jsonStat";

        $.ajax({
            type: "GET",
            url: urlApiPcAxis,
            //async: false,
            /*headers: {
                Accept: "application/jsonStat"
            },*/
            success: function(data, status, jqXHR) {
                resolve(data);
            },
            error: function(jqXHR, status) {
                reject(jqXHR);
            }
        });
    })
}

//getValue() converts a dimension/category object into a data value in three steps.
//Input example: {"concept":"UNR","area":"US","year":"2010"}
//Output example: 9.627692959
function getValue(jsonstat, query) {

    //1. {"concept":"UNR","area":"US","year":"2010"} ==> [0, 33, 7]
    var indices = getDimIndices(jsonstat, query);

    //2. [0, 33, 7] ==> 403
    var index = getValueIndex(jsonstat, indices);

    //3. 403 ==> 9.627692959
    return jsonstat.value[index];
}

//getDimIndices() converts a dimension/category object into an array of dimensions' indices.
//Input example: {"concept":"UNR","area":"US","year":"2010"}
//Output example: [0, 33, 7]
function getDimIndices(jsonstat, query) {

    var
        dim = jsonstat.dimension,
        ids = jsonstat.id || dim.id; //JSON-stat 2.0-ready

    for (var arr = [], i = 0, len = ids.length; i < len; i++) {
        arr[i] = getDimIndex(dim, ids[i], query[ids[i]]);
    }

    return arr;
}

//getValueIndex() converts an array of dimensions' indices into a numeric value index.
//Input example: [0, 33, 7]
//Output example: 403
function getValueIndex(jsonstat, indices) {

    var size = jsonstat.size || jsonstat.dimension.size; //JSON-stat 2.0-ready

    for (var i = 0, ndims = size.length, num = 0, mult = 1; i < ndims; i++) {
        mult *= (i > 0) ? size[ndims - i] : 1;
        num += mult * indices[ndims - i - 1];
    }

    return num;
}

//getDimIndex() converts a dimension ID string and a category ID string into the numeric index of that category in that dimension.
//Input example: "area", "US"
//Output example: 33
function getDimIndex(dim, name, value) {

    //In single category dimensions, "index" is optional
    if (!dim[name].category.index) {
        return 0;
    }

    var ndx = dim[name].category.index;

    if (name.toUpperCase().indexOf("TIME") == 0) {
        var res = dim[name].category
    }

    //"index" can be an object or an array
    if (Object.prototype.toString.call(ndx) !== "[object Array]") { //Object
        return ndx[value];
    } else { //Array
        return ndx.indexOf(value); //Polyfill required in old browsers
    }
}

//Validate
function JSONstat(jsonstat) {

    if (!jsonstat) {
        window.alert("Error: no response could be retrieved.");
        return NULL;
    }

    //If no "class", "bundle" response:
    //use the first dataset available
    //(assuming single dataset bundle response)
    //[Of course, it'd be better to add an argument
    //to the function to pass a dataset ID if
    //bundle responses must be properly supported.]

    if (!jsonstat.class) {

        jsonstat = jsonstat[Object.keys(jsonstat)[0]]; //Polyfill required in old browsers

    } else {

        //Verify it's a "dataset" response
        if (jsonstat.class !== "dataset") {
            window.alert("Error: response was not a JSON-stat bundle or dataset response.");
            return NULL;
        }
    }

    //Program requires "value" and "dimension" properties
    if (!jsonstat.value || !jsonstat.dimension) {
        window.alert("Error: response is not valid JSON-stat or does not contain required information.");
        return NULL;
    }

    return jsonstat;
}

//show() displays the query and its result.
function show(query, result) {

    var text = "";

    for (var prop in query) {
        text += prop + "=" + query[prop] + " ";
    }

    text += "==> " + result;

    document.getElementsByTagName("p")[0].innerHTML = text;
}

function addCharMorisArray(query, result) {

    //var
    var text = "";

    var dataCharMoris = {
        "TIME_PERIOD": "",
        "OBS": 0
    }

    for (var prop in query) {

        if (prop == "TIME_PERIOD") {
            dataCharMoris.TIME_PERIOD = query[prop];
        }
    }

    dataCharMoris.OBS = result == undefined ? 0 : result;

    arrayCharMorisArray.push(dataCharMoris);
}

function buidChatBarMoris(arrayCharMorisArray) {

    var config = {
        data: arrayCharMorisArray, //data,
        xkey: 'TIME_PERIOD',
        barColors: ['#CF6F40'],
        ykeys: ['OBS'],
        labels: ['OBS'],
        fillOpacity: 0.6,
        hideHover: 'auto',
        resize: true,
    };

    config.element = 'barCharJsonStat';
    Morris.Bar(config);
}

Métodos para obtener información a través de la API

Método Indicadores

Cómo utilizar el método

Parámetros de entrada

Estructura de salida

Header

Serie

OBSERVATIONS

Método Catálogo de metadatos

Cómo utilizar el método

Parámetros de entrada

Estructura de salida

Ejemplos de uso de la API

Obtener datos de la serie histórica del indicador de Población total, en los Estados Unidos Mexicanos, en idioma español, en formato JSON

HTML

JavaScript

Python

R

PC-Axis

Método Indicadores

Parámetros de entrada:

Código

HTML

JavaScript

Json-Stat

Método Catálogo de metadatos

Parámetros de entrada:

Código

HTML

JavaScript