Este paquete de Python proporciona una interfaz fácil de usar para la API de la Comisión para el Mercado Financiero de Chile (CMF). Permite recuperar reportes bancarios e indicadores financieros para un análisis más profundo.
- Python 3.8+
- requests
- dateutil
De momento estoy recuperando mi acceso a mi cuenta de Pypi, por ende, no se puede instalar directo. A pesar de eso, se puede ocupar de manera local redireccionando la carpeta a donde se guardo el fichero
El paquete se puede instalar fácilmente utilizando pip. Solo necesitas ejecutar el siguiente comando:
CmfBancos es una clase que unifica la funcionalidad de las clases IndicadoresFinancierosChilenos y ReportesBancariosChilenos, permitiendo un acceso más conveniente a todas las funciones.
La clase CmfBancos hereda de ambas clases, por lo que todos los métodos descritos anteriormente para IndicadoresFinancierosChilenos y ReportesBancariosChilenos están disponibles en una instancia de CmfBancos.
Para crear una instancia de CmfBancos, necesitas proveer tu API key como un argumento al inicializador. Puedes también proporcionar un tiempo de espera (en segundos) que se utilizará para todas las solicitudes a la API.
Ejemplo de uso:
from cmf import CmfBancos
import os
# Utiliza la variable de entorno CMF_API_KEY para la API key
api_key = os.getenv("CMF_API_KEY")
# Crea una instancia de CmfBancos
cmf_client = CmfBancos(api_key)
# Ahora puedes utilizar todos los métodos descritos anteriormente
dolares = cmf_client.get_dolares(from_="2023/01/01", to_="2023/07/01")
balance = cmf_client.ac_riesgo_credito(cantidad="12", instituciones="001")
print(dolares)
print(balance)Es altamente recomendable guardar tus claves o API kets en tus variables de entorno. Un tutorial corto sobre como hacerlo, lo puedes encontrar en el siguiente video:
Por defecto, si no se proporciona una fecha de inicio (from_), se establecerá en un año antes de la fecha de fin (to_). Si no se proporciona una fecha de fin, se establecerá en la fecha actual. Si no se proporcionan ambas fechas, la fecha de inicio será un año antes de la fecha actual y la fecha de fin será la fecha actual. Todos los métodos aceptan el formato "YYYY/MM/DD" si se desean datos diarios. Si se desean datos mensuales se debe ingresar el formato "YYYY/MM".
Los siguientes son los métodos disponibles en la clase IndicadoresFinancierosChilenos:
-
get_dolares(from_:str = None, to_:str = None):- from_ (str, optional): La fecha de inicio en formato "YYYY/MM/DD" para obtener los datos de tipo de cambio de dólares.
- to_ (str, optional): La fecha de fin en formato "YYYY/MM/DD" para obtener los datos de tipo de cambio de dólares.
Obtiene los datos de tipo de cambio de dólares para el período especificado.
Ejemplo de uso:
dolares = cmf_client.get_dolares(from_="2023/01/01", to_="2023/07/01") print(dolares)
-
get_euros(from_:str = None, to_:str = None):- from_ (str, optional): La fecha de inicio en formato "YYYY/MM/DD" para obtener los datos de tipo de cambio de euros.
- to_ (str, optional): La fecha de fin en formato "YYYY/MM/DD" para obtener los datos de tipo de cambio de euros.
Obtiene los datos de tipo de cambio de euros para el período especificado.
Ejemplo de uso:
euros = cmf_client.get_euros(from_="2023/01/01", to_="2023/07/01") print(euros)
-
get_ipc(from_:str = None, to_:str = None):- from_ (str, optional): El mes de inicio en formato "YYYY/MM" para obtener los datos del Índice de Precios al Consumidor (IPC).
- to_ (str, optional): El mes de fin en formato "YYYY/MM" para obtener los datos del IPC.
Obtiene los datos del Índice de Precios al Consumidor (IPC) para el período especificado.
Ejemplo de uso:
ipc = cmf_client.get_ipc(from_="2023/01", to_="2023/07") print(ipc)
-
get_tip(from_:str = None, to_:str = None):- from_ (str, optional): El mes de inicio en formato "YYYY/MM" para obtener los datos de la Tasa de Interés Promedio (TIP).
- to_ (str, optional): El mes de fin en formato "YYYY/MM" para obtener los datos de la TIP.
Obtiene los datos de la Tasa de Interés Promedio (TIP) para el período especificado.
Ejemplo de uso:
tip = cmf_client.get_tip(from_="2023/01", to_="2023/07") print(tip)
-
get_tmc(from_:str = None, to_:str = None):- from_ (str, optional): El mes de inicio en formato "YYYY/MM" para obtener los datos de la Tasa Máxima Convencional (TMC).
- to_ (str, optional): El mes de fin en formato "YYYY/MM" para obtener los datos de la TMC.
Obtiene los datos de la Tasa Máxima Convencional (TMC) para el período especificado.
Ejemplo de uso:
tmc = cmf_client.get_tmc(from_="2023/01", to_="2023/07") print(tmc)
-
get_uf(from_:str = None, to_:str = None):- from_ (str, optional): El mes de inicio en formato "YYYY/MM" para obtener los datos de la Unidad de Fomento (UF).
- to_ (str, optional): El mes de fin en formato "YYYY/MM" para obtener los datos de la UF.
Obtiene los datos de la Unidad de Fomento (UF) para el período especificado.
Ejemplo de uso:
uf = cmf_client.get_uf(from_="2023/01", to_="2023/07") print(uf)
-
get_utm(from_:str = None, to_:str = None):- from_ (str, optional): El mes de inicio en formato "YYYY/MM" para obtener los datos de la Unidad Tributaria Mensual (UTM).
- to_ (str, optional): El mes de fin en formato "YYYY/MM" para obtener los datos de la UTM.
Obtiene los datos de la Unidad Tributaria Mensual (UTM) para el período especificado.
Ejemplo de uso:
utm = cmf_client.get_utm(from_="2023/01", to_="2023/07") print(utm)
-
instituciones_bancarias():No recibe ningún parámetro de entrada. Obtiene el listado completo de instituciones bancarias disponibles en Chile de hace tres meses atrás.
Para proximas versiones del paquete se espera incluir la funcionalidad de "viaje en el tiempo", es decir, mostrar las instituciones bancarias chilenas para un periodo especifico en el tiempo (e.g. Mayo de 2013)
Ejemplo de uso:
instituciones = cmf_client.instituciones_bancarias() print(instituciones)
-
ac_capital_basico(cantidad:str, instituciones:str):Obtiene el capital básico para múltiples períodos de tiempo de las instituciones bancarias especificadas.
Ejemplo de uso:
capital_basico = cmf_client.ac_capital_basico(cantidad="12", instituciones="001") print(capital_basico)
-
ac_patrimonio_efectivo(cantidad:str, instituciones:str):Obtiene el patrimonio efectivo para múltiples períodos de tiempo de las instituciones bancarias especificadas.
Ejemplo de uso:
patrimonio_efectivo = cmf_client.ac_patrimonio_efectivo(cantidad="12", instituciones="001") print(patrimonio_efectivo)
-
ac_riesgo_credito(cantidad:str, instituciones:str):Obtiene los activos ponderados por riesgo de crédito (IRS) para múltiples períodos de tiempo de las instituciones bancarias especificadas.
Ejemplo de uso:
riesgo_credito = cmf_client.ac_riesgo_credito(cantidad="12", instituciones="001") print(riesgo_credito)
-
ac_capital_activos(cantidad:str, instituciones:str):Obtiene el cociente de capital básico / activos totales (IRE) para múltiples períodos de tiempo de las instituciones bancarias especificadas.
Ejemplo de uso:
capital_activos = cmf_client.ac_capital_activos(cantidad="12", instituciones="001") print(capital_activos)
-
ac_componentes_todos(year:str, month:str, instituciones:str):Obtiene todas las cifras de los componentes de la Adecuación de Capital para la institución y el período de tiempo especificados.
Ejemplo de uso:
componentes_todos = cmf_client.ac_componentes_todos(year='2020', month='09', instituciones="001") print(componentes_todos)
-
bs_institucion(year:str, instituciones:str):Obtiene el balance de una institución con resultados para todos los meses del año especificado.
Ejemplo de uso:
balance_institucion = cmf_client.bs_institucion(year="2022", instituciones="001") print(balance_institucion)
-
bs_lista_cuentas(year:str, month:str):Obtiene la lista de cuentas existentes en el balance durante el mes y el año especificado.
Ejemplo de uso:
lista_cuentas = cmf_client.bs_lista_cuentas(year="2022", month="09") print(lista_cuentas)
-
bs_cuentas_instituciones(year:str, codigo_cuenta:str):Obtiene el detalle de una cuenta del balance durante el año especificado para todas las instituciones.
Ejemplo de uso:
# Detalle de la cuenta de Cuentas por cobrar a filiales del banco por servicios prestados (aplica solo a nivel individual del banco). cuenta_instituciones = cmf_client.bs_cuentas_instituciones(year="2022", codigo_cuenta="190000600") print(cuenta_instituciones)
-
bs_historico_cuenta_institucion(periodo:str, month:str, codigo_cuenta:str, instituciones:str):Obtiene el detalle de una cuenta del balance durante el mes especificado y un periodo predeterminado de años para las instituciones especificadas. El parametro ´´´periodo´´´ puede tener los siguientes valores: "periodo1" (Años 1995-2007), "periodo2" (2008) y "periodo3" (2009-hoy).
Ejemplo de uso:
historico_cuenta = cmf_client.bs_historico_cuenta_institucion( periodo='periodo3', month='06', codigo_cuenta='246000304', instituciones='001' ) print(historico_cuenta)
-
er_institucion(year:str, instituciones:str):Obtiene el estado de resultados de una institución para el año especificado. Para este metodo es recomendable cambiar el parametro ´´´timeout´´´ a un numero grande (e.g. 10000). Lo anterior se debe a que la respuesta enviada desde la API es muy grande y toma bastante tiempo. Eventualmente la misma API de la CMF puede tener un timeout que aborte la couminicación de la solicitud. Se recomienda buscar la cuentas de mayor impacto y solicitarlas de manera individual por banco.
Ejemplo de uso:
estado_resultados = cmf_client.er_institucion(year="2022", instituciones="001") print(estado_resultados)
-
er_lista_cuentas(year:str, month:str):Obtiene la lista de cuentas existentes en el estado de resultados durante el mes y el año especificado. Considerar que todos los reportes tienen un desface de 3 o 4 meses (trimestre) respecto a la fecha actual.
Ejemplo de uso:
lista_cuentas_er = cmf_client.er_lista_cuentas(year="2023", month="01") print(lista_cuentas_er)
-
er_cuenta_instituciones(year:str, month:str, codigo_cuenta:str):Obtiene el detalle de una cuenta del estado de resultados durante el mes y el año especificado para todas las instituciones.
Ejemplo de uso:
# Solicitar los datos para las Comisiones por asesorías financieras durante Enero de 2023 cuenta_instituciones_er = cmf_client.er_cuenta_instituciones(year="2022", month="09", codigo_cuenta="416280224") print(cuenta_instituciones_er)
-
fb_perfil_institucion(instituciones:str, year:str, month:str):Obtiene el perfil de una institución financiera para el año y mes especificados.
Ejemplo de uso:
perfil_institucion = cmf_client.fb_perfil_institucion(instituciones="001", year="2022", month="09") print(perfil_institucion)
-
fb_accionistas_institucion(instituciones:str, year:str, month:str):Obtiene los accionistas de una institución financiera para el año y mes especificados.
Ejemplo de uso:
accionistas_institucion = cmf_client.fb_accionistas_institucion(instituciones="001", year="2022", month="09") print(accionistas_institucion)
-
fb_ejecutivos_institucion(instituciones:str, year:str, month:str):Obtiene los ejecutivos principales de una institución financiera para el año y mes especificados.
Ejemplo de uso:
ejecutivos_institucion = cmf_client.fb_ejecutivos_institucion(instituciones="001", year="2022", month="09") print(ejecutivos_institucion)
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 de la CMF.
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.