Demo: Usando la clase ServicioWeb del paquete bccr
Randall Romero Aguilar
Primera versión: 21 de diciembre de 2019
Esta actualización: 8 de abril de 2020.
Este cuaderno de Jupyter ilustra el uso del paquete de Python bccr, con el cual se facilita la descarga de datos del servicio Web del Banco Central de Costa Rica.
Primero cargamos algunos paquetes: bccr para consultar datos del servicio web, pandas para manipular los datos en Python, numpy para calcular un promedio (más adelante), matplotlib para hacer gráficos.
import bccr
import pandas as pd
import numpy as np
import matplotlib.pyplot as plt
plt.style.use('seaborn')
%matplotlib inline
1. Iniciando una consulta
Para utilizar este paquete, es necesario opcional inscribirse en la página de servicio web del BCCR en https://www.bccr.fi.cr/seccion-indicadores-economicos/servicio-web/
Una vez llenado el formulario, recibirá un token de parte del BCCR en el correo suministrado. Este paso solo debe realizarse una única vez.
Una vez obtenido el token, se crea un objeto (acá llamado consulta) de la clase ServicioWeb, donde se pasa por argumentos las credenciales del usuario.
consulta = bccr.ServicioWeb()
consulta = bccr.ServicioWeb('Nombre', 'correo.electronico@servicio.com', 'TOKEN_BCCR')
2. Buscando una serie
Para importar una serie del servicio web, es necesario saber su código. Este código es el mismo que se ingresaría en el formulario disponible en la página del BCCR
En este enlace el Banco comparte los código de las variables: https://gee.bccr.fi.cr/Indicadores/Suscripciones/UI/ConsultaIndicadores/ObtenerArchivo
Para facilitar encontrar las series, la clase bccr.ServicioWeb provee la función buscar. Acá, por ejemplo, buscamos la frase 'medio circulante':
consulta.buscar(frase='medio circulante')
El resultado nos indica que los códigos 1445,1479 y 2936 corresponden a series que incluyen la frase exacta “medio circulante” en su descripción. Si no sabemos la frase exacta pero sí varias palabras que deben aparecer en la descripción (en cualquier orden), usamos buscar con la opción todos
consulta.buscar(todos='numerario poder público')
También tenemos la opción de buscar series donde solo algunos de los términos aparecen en la descrición. Podemos además filtrar los resultados por la frecuencia de los datos (A anual, 6M semestral, Q trimestral, M mensual, W semanal, y Ddiaria.
consulta.buscar(algunos='japón yen', frecuencia='D')
3. Descargando datos
3.1 Descargando una serie
Supongamos que queremos descargar datos del medio circulante (sistema bancario nacional). Arriba encontramos que su código es el 1445. Para ello llamamos el objeto directamente:
# M1 = consulta(1445) # más rápido, si no se desea cambiar el nombre de la serie
M1 = consulta({'1445':'M1'}) # pasando un diccionario para renombrar las series
M1.plot();
En la celda anterior, pasar el indicador como diccionario {'1445':'M1'} es opcional, lo hacemos acá para cambiar el nombre de la serie. Observe que si bien podemos buscar la serie por código con un entero 1445 o un texto '1445', el resultado siempre dará el nombre de la variable como texto.
3.2 Descargando dos series de la misma frecuencia
Es posible además pasarle varios códigos a datos de una vez, ya sea en una lista [1365,1445] o tupla (1365, 1445) o bien las llaves de un diccionario (como se ilustra en la siguiente celda). Acá descargamos, además del medio circulante, en numerario en poder del público. El resultado será una tabla pandas.DataFrame, donde cada columna corresponde a una variable.
series = {'1365':'NPP', '1445':'M1'}
dinero = consulta(series)
dinero.plot();
3.3 Descargando varias series de distinta frecuencia
El objeto consulta permite también descargar variables de distinta frecuencia, convirtiéndolos a una frecuencia común. Por ejemplo, suponga que desea, además de los datos anteriores, la serie de la tasa básica pasiva:
consulta.buscar(frase='tasa básica pasiva calculada')
Vemos que el código 423 es de una serie diaria, mientras que los datos de M1y NPP eran mensuales. En la siguiente celda, le indicamos a consulta que debe convertir los datos de mayor a menor frecuencia usando un promedio (func=np.mean). Es posible además restringir el rango de los datos con los parámetros FechaInicio= y FechaFinal=.
series = {'1365':'NPP', '1445':'M1', '423':'Tasa básica'}
datos = consulta(series, FechaInicio=2015, func=np.mean)
datos.plot(subplots=True, figsize=[12,6]);
datos.tail()
La frecuencia de los datos puede controlarse con el parámetro freq=. Si no se indica, se obtienen los datos de menor frecuencia. Es posible además indicar distintos métodos de conversión para func=, pasando un diccionario de la forma {código1: función1, código2: función2, ,...}.
4. Buscar información
4.1 Buscar información de una variable
Suponga que deseamos una variable que muestre todos estos términos
consulta.buscar(todos='exportaciones importaciones encadenado original')
El resultado obtenido nos deja una duda, porque en DESCRIPCION indica que se trata de importaciones pero en descripcion menciona exportaciones. Para obtener más información de quien es una variable:
consulta.quien(33472)
Lo anterior nos indica que la variable 33472 está ligada a la 33439. Para ver todas las sub-variables de 33439, usamos la función subcuentas:
consulta.subcuentas(33439);
Lo anterior nos permite deducir que en realidad 33472 se trata de datos de importaciones.
4.2 Buscar series relacionadas
El ejemplo anterior ilustró el uso de subcuentas para encontrar series relacionadas.
consulta.buscar(todos='Producto Interno Bruto volumen encadenado original', frecuencia='Q')
En este caso concreto, nos interesa conocer componentes del PIb en colones (en vez de su variación interanual). Las subcuentas de 33438 nos ayuda a encontrar los códigos relevantes, a partir de lo cual podemos hacer un diccionario de las variables de interés:
consulta.quien(33438)
ctas = consulta.subcuentas(33438)
series = {'33438':'PIB',
'33441':'Demanda Interna',
'33444':'Gasto',
'33447': 'C',
'33450':'G',
'33453':'FBKF',
'33456': 'I',
'33462': 'X', '33465':'Xb', '33468':'Xs',
'33471': 'M', '33474':'Mb', '33477':'Ms',
}
cuentas_nacionales = consulta.datos(ctas).rename(columns=series)
Al parecer, el servicio web no proporciona directamente los datos para las variables sub-totales. Los demás datos los graficamos a continuación:
cuentas_nacionales.plot(figsize=[12,5])
5. Exportando datos
Finalmente, podemos exportar los datos de pandas a otros formatos; aquí se muestran los comandos para obtener archivos CSV (to_csv), Excel (to_excel) y Latex (to_latex):
cuentas_nacionales.to_csv('cuentas.csv')
cuentas_nacionales.to_excel('cuentas.xlsx')
cuentas_nacionales.to_latex('cuentas.tex')
También podemos exportarlos a Stata (to_stata), aunque primero es necesario hacer un par de ajustes (indexar los datos por fechas en vez de períodos y quitar espacios y usar solo caracteres ASCII en los nombres de las columnas)
cuentas_nacionales.index = cuentas_nacionales.index.to_timestamp()
cuentas_nacionales.to_stata('cuentas.dta')
6. Obteniendo ayuda
Para terminar, en caso de que olvidemos cómo utilizar un objeto de la clase ServicioWeb, basta con visualizarlo para obtener un pequeño resumen de este tutorial :
consulta
Advertencia
Este paquete ha sido desarrollado por Randall Romero Aguilar, y se ha compartido para facilitar la obtención de datos del BCCR a quien así lo necesite.
NO es un paquete oficial del Banco Central de Costa Rica, ni cuenta con aprobación o patrocinio del BCCR.
El paquete se ofrece gratuitamente pero SIN NINGUNA GARANTIA acerca de su correcto funcionamiento.Aunque he puesto el mayor esfuerzo en que este paquete funcione correctamente, algunos errores pueden persistir. Si encuentra alguno, o bien si tiene sugerencias acerca de futuras mejoras, por favor envíeme un correo a randall.romero@outlook.com.
© Randall Romero Aguilar, 2015-2020