Skip to main content

bccr

Una API de Python para descargar datos del Banco Central de Costa Rica

El propósito de este paquete es proveer herramientas para buscar y descargar indicadores publicados por el Banco Central de Costa Rica.

El paquete ofrece dos clases para buscar datos y descargarlos:

Independientemente de la clase utilizada, los datos se descargan y se presentan en una tabla de pandas, en la cual cada fila corresponde a un período (día, mes, trimestre, año) y cada columna a un indicador.

Breves indicaciones acerca del uso del paquete

Las API de ambas clases son similares. En esencia, se crea un objeto consulta y se utiliza para buscar códigos de indicadores (los cuales difieren según se trate del Servicio Web o de la página de indicadores económicos).

Este video de YouTube contiene un tutorial acerca de cómo utilizar el paquete.

Usando ServicioWeb

Primero importamos una instancia de ServicioWeb llamada SW

from bccr import SW      

Conociendo los códigos de los indicadores, se descargan los datos con

SW(nombre1=codigo1, nombre2=codigo2, ..., nombreN=codigoN)    

En la línea anterior, nombre1, nombre2, y nombreN son los nombres que se desea dar a los indicadores, y codigo1, codigo2, y codigoN son números enteros que identifican a esos indicadores en el Servicio Web.

El resultado se presenta como una tabla de datos de pandas, en la que cada fila es un período (día,mes, trimestre, año) y cada columna un indicador, con nombres [nombre1, nombre2, ..., nombreN].

Para buscar los códigos de los indicadores se usa el método buscar:

SW.buscar("descripción tiene todas estas palabras") 
SW.buscar(frase="descripción contiene esta frase exacta")
SW.buscar(algunos="descripción tiene alguna de estas palabras")

Además, para buscar cuentas relacionadas (por ejemplo, si se conoce el codigo del IMAE y se desea buscar los códigos de IMAE por actividad)

SW.quien(codigo)
SW.subcuentas(codigo)

Usando PaginaWeb

Importamos una instancia de PaginaWeb()

from bccr import PW      

Para buscar los códigos de los indicadores

PW.buscar(frase="descripción contiene esta frase exacta")
PW.buscar(todos="descripción tiene todas estas palabras")
PW.buscar(algunos="descripción tiene alguna de estas palabras")

Una diferencia importante con respecto al servicio web es que una página web se refiere a un cuadro publicado (que puede tener uno o más indicadores), mientras que un código de servicio web está asociado a un único indicador.

Una vez conocidos los códigos de los indicadores, se descargan los datos con

PW(codigo1, codigo2, ..., codigoN)    

lo cual da por resultado una tabla de datos de pandas, con una estructura similar a la que da SW.

Usando GUI

Este paquete también incluye una interfase gráfica, desarrollada con dash y utilizando ServicioWeb, que permite consultar los datos y descargarlos con botones, en formatos de Excel, Stata y CSV. Además, la interfase muestra la línea de comando de SW que ejecuta la consulta deseada (por ejemplo, para incluirla en un script posteriormente).

Para utilizar la interfase gráfica

from bccr import GUI
GUI()

Esto abrirá la interfase en su navegador de internet predeterminado.

Aviso importante

Este paquete no es un producto oficial de BCCR. El autor lo provee para facilitar el manejo de datos, pero no ofrece ninguna garantía acerca de su correcto funcionamiento.

Metadata

Release files for bccr 2022.4.26

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bccr 2022.4.26
File Size Uploaded Provenance Actions
bccr-2022.4.26.tar.gz 34.9 kB Without provenance Details for bccr-2022.4.26.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for bccr 2022.4.26
File Interpreter ABI Platform Actions
bccr-2022.4.26-py3-none-any.whl Python 3 none any Details for bccr-2022.4.26-py3-none-any.whl

Total release size: 369.8 kB

Release files / bccr-2022.4.26.tar.gz

Download URL bccr-2022.4.26.tar.gz
Size 34.9 kB
Tags Source
SHA-256 checksum
How to use checksums
411896184406039cada0a9fe94d0b516428b2b9b5ef4f0d4914c966e2c353c45
BLAKE2b-256 checksum
How to use checksums
ce11981f21fb6e5504c0768764f228196e6f378db786c104d54fb979670c0abc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.62.3 importlib-metadata/4.8.1 keyring/23.1.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

Release files / bccr-2022.4.26-py3-none-any.whl

Download URL bccr-2022.4.26-py3-none-any.whl
Size 334.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
278c9c3951022da083e36b1e4f05cea5e0a6ee5e1f670a106542675a2308952e
BLAKE2b-256 checksum
How to use checksums
acbeec85443da70d25fff5fe83ac7a608feefe09e29cdd4310acfb617bd458f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.62.3 importlib-metadata/4.8.1 keyring/23.1.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

Security for bccr 2022.4.26

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page