SDK de la API del Banco Central de Chile (BCCh)

Contenidos

Descripción general
Requerimientos
Instalación
Demo
Documentación
Disclaimer

Descripción general ⬆️

Cliente no oficial de la API de la bases de datos estadísticos del Banco Central de Chile. Está diseñada para extraer datos macroeconómicos, los cuales deberán ser convertidos en hallazgos que gatillen patrones de comportamiento en Chile y en el mundo. Fue programado en Python 🐍

Escribí un articulo en mi blog comentando su funcionalidad, recomendaciones y un caso de uso práctico. Pueden encontrar el articulo en este link.

Requerimientos ⬆️

Necesitaras acceso a los datos de la API. Los puedes solicitar en el siguiente link.
Python >= 3.7

Instalación ⬆️

pip install bcch

Demo ⬆️

#Librerias base
import pandas as pd
import os

from bcch import BancoCentralDeChile

# Por seguridad, es mejor guardar las contraseñas y usuarios en las variables de entorno
bcch_user = os.environ['BCCH_USER']
bcch_pwd = os.environ['BCCH_PWD']

# Creación de la instancia
client = BancoCentralDeChile(bcch_user, bcch_pwd)

# Verificar que series son de frequencia trimestral
resp = pd.DataFrame(
    client.get_busqueda(frecuencia='quarterly')
    )

# Solicitar la Deuda pública en relación al PIB (porcentaje del PIB)
resp = pd.DataFrame(
    client.get_macro(serie='F051.D7.PPB.C.Z.Z.T')
    )

Tutorial sobre como guardar y llamar variables de ambiente en Python -> Hiding Passwords and Secret Keys in Environment Variables (Windows)

Documentación ⬆️

Todos los métodos de la documentación van a ocupar la siguiente instancia de la clase del SDK

import os
from bcch import BancoCentralDeChile

# Por seguridad, es mejor guardar las contraseñas y usuarios en las variables de entorno
bcch_user = os.environ['BCCH_USER']
bcch_pwd = os.environ['BCCH_PWD']

# Creación de la instancia
client = BancoCentralDeChile(bcch_user, bcch_pwd)

Series macroeconomicas

get_busqueda: Método que permite ver la lista de series disponibles por frecuencia y su metadata.
- Argumentos:
  - frecuencia(str): Requerido - Periodicidad para la cual se quiere consultar el catálogo de series disponibles. Puede tomar los valores DAILY, MONTHLY, QUARTERLY o ANNUAL. Los valores pueden ir en minúsculas o mayúsculas.
get_macro: Método para solicitar datos macroeconómicos en base a una id correspondiente.
- Argumentos:
  - serie(str): Requerido - ID de los datos a solicitar. El catalogo completo se puede revisar en el archivo Excel del Banco u ocupando el metodo get_busqueda
  - from_(str): Opcional - Ingresar fecha desde la cual se requiere recoger datos. Si el parámetro no está presente, se recoge por defecto desde el primer dato disponible. El formato a ocupar es el siguiente YYYY-MM-DD
  - to_(str): Opcional - Ingresar fecha hasta la cual se requiere recoger datos. Si el parámetro no está presente, se recoge por defecto hasta el último dato disponible. El formato a ocupar es el siguiente YYYY-MM-DD

Disclaimer ⬆️

La información contenida en este documento es solo para fines informativos y educativos. Nada de lo contenido en este documento se podrá interpretar como asesoramiento financiero, legal o impositivo. El contenido de este documento corresponde únicamente a la opinión del autor, el cual no es un asesor financiero autorizado ni un asesor de inversiones registrado. El autor no está afiliado como promotor de los servicios del Banco Central de Chile.

Este documento no es una oferta para vender ni comprar instrumentos financieros. Nunca invierta más de lo que puede permitirse perder. Usted debe consultar a un asesor profesional registrado antes de realizar cualquier inversión.

LautaroParada/bcch-sdk