Skip to content

BCRA Wrapper in Python: A Python wrapper to easily retrieve data from the BCRA in Pandas format using the official API.

License

Notifications You must be signed in to change notification settings

Jaldekoa/BCRA-Wrapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bcraapi: Python API for BCRA (Banco Central de la República Argentina)

Tests

bcraapi is a Python wrapper for BCRA APIs provided by Banco Central de la República Argentina itself. It makes use of requests and pandas and returns the data in a pandas DataFrame.

The BCRA API does not require tokens or registration, so do not hesitate to use it.

Installation

pip install bcraapi

APIs of the BCRA

  • Estadísticas cambiarias v1.0

You will be able to access to resources related to exchange rate information published by the BCRA.

  • Cheques denunciados v1.0

You will be able to consult reported, lost, stolen or adulterated checks. The information available here is provided by the financial entities operating in the country and is published without alterations.

  • Estadísticas monetarias y principales variables v4.0

You will be able to access resources related to the main and monetary variables information published by the BCRA.

  • Central de Deudores v1.0

You will be able to access resources related to the main variables information published by the BCRA.


API Cheques denunciados v1.0

Entidades

Method to obtain the list of all the banking entities in the country with their respective entity code.

from bcraapi import cheques

df = cheques.entidades()

Returns

DataFrame with the list of all the banking entities in the country with their respective entity code.

Denunciados

Method to know if a check from a certain entity is registered as reported or not.

from bcraapi import cheques

df = cheques.denunciados(codigo_entidad=11, numero_cheque=20377516)

Args

Parameter Type Description
codigo_entidad int ID of the financial entity. It can be queried via entidades().
numero_cheque int Corresponds to the check number to be consulted.

Returns

DataFrame with the result if a check is registered as reported or not.


API Estadísticas v4.0

Metodología

Method for obtaining the methodologies corresponding to each reported variable published by the BCRA.

from bcraapi import estadisticas

df = estadisticas.metodologia()

Args

Parameter Type Description
idvariable int ID of the desired variable.

Keyword Args

Parameter Type Description
desde str The start date of the range to be queried, it must be in the format YYYY-MM-DD.
hasta str The end date of the range to be queried, it must be in the format YYYY-MM-DD.
offset int Records to discard for paging. Default: 0.
limit int Records to be returned by the service. The maximum value is 3000. Default: 1000.

Returns

DataFrame with the methodology corresponding to the reported variable.

Datos de Variables Monetarias

Method for obtaining the evolution of values for the monetary variable within a date range.

from bcraapi import estadisticas

df = estadisticas.datos_monetarias(id_variable=1, desde="2024-02-01", hasta="2024-02-05", limit=1000, offset=0)

Args

Parameter Type Description
id_variable int ID of the desired variable. Required

Keyword Args

Parameter Type Description
desde str The start date of the range to be queried, it must be in the format YYYY-MM-DD.
hasta str The end date of the range to be queried, it must be in the format YYYY-MM-DD.
offset int Records to discard for paging. Default: 0.
limit int Records to be returned by the service. The maximum value is 3000. Default: 1000.

Returns

DataFrame with the values for the selected variable and date range.

Monetarias

Method for obtaining a list of all monetary variables published by the BCRA.

from bcraapi import estadisticas

df = estadisticas.monetarias(id_variable=1, limit=1000, offset=0)

Keyword Args

Parameter Type Description
id_variable int Optional. ID of the desired variable.
categoria str Indicates the classification of the monetary variable. It is not necessary to enter the entire text.
tipo_serie str It corresponds to the economic characterization of the variable. It is not necessary to enter the entire text.
periodicidad str Frequency: daily D, monthly M, quarterly T (or Q).
unidad_expresion str Unit of measurement for the economic variable. It is not necessary to enter the entire text.
offset int Records to discard for paging. Default: 0.
limit int Records to be returned by the service. The maximum value is 3000. Default: 1000.

Returns

DataFrame with the values for the selected variable and date range.


API Estadísticas Cambiarias v1.0

Maestro de monedas

Method to obtain the list of all ISO currencies in force, with their respective denominations. denomination.

from bcraapi import estadisticascambiarias

df = estadisticascambiarias.maestros_divisas()

Returns

DataFrame with the list of currencies of the BCRA.

Cotizaciones por fecha

Method to obtain the list of all current foreign exchange rates published by the BCRA for a given date (yyyy-MM-dd). BCRA for a given date. If no date is entered, the last existing quote will be returned. the last existing quotation will be returned.

from bcraapi import estadisticascambiarias

df = estadisticascambiarias.cotizaciones(fecha="2024-06-12")

Args

Parameter Type Description
fecha str Date of the data to be consulted, it must have the format YYYY-MM-DD.

Returns

DataFrame with the values for the selected date.

Evolución de moneda

Method to obtain the price evolution of a currency (ISO) in a particular date range. If the date from and date to parameters are not entered, the last existing quote will be returned. the last existing quote will be returned.

from bcraapi import estadisticascambiarias

df = estadisticascambiarias.cotizaciones_moneda(moneda="USD")

Args

Parameter Type Description
moneda str ISO currency. This parameter is required
fecha_desde str The start date of the range to be queried, it must be in the format YYYY-MM-DD.
fecha_hasta str The end date of the range to be queried, it must be in the format YYYY-MM-DD.
limit int Maximum amount to be returned per application. Must be greater than 10 and less than 1000.
ofset int Exclude from the answer the first N elements of the contributions to be refunded..

Returns

Datarame with the evolution of the exchange rate of a currency.


API Central de Deudores v1.0

Deudas

Method to obtain the credit situation, amount of debt, days in arrears and observations corresponding to the last period reported by the entities to the BCRA.

from bcraapi import centraldeudores

df = centraldeudores.deudas(30500010912)

Args

Parameter Type Description
identificacion str Corresponds to CUIT/CUIL/CDI, it must be 11 characters long.

Returns

DataFrame with the credit situation, amount of debt, days in arrears and observations corresponding to the last period reported by the entities to the BCRA.

Deudas Históricas

Method to obtain the credit situation for the last 24 months.

from bcraapi import centraldeudores

df = centraldeudores.deudas_historicas(30500010912)

Args

Parameter Type Description
identificacion str Corresponds to CUIT/CUIL/CDI, it must be 11 characters long.

Returns

DataFrame with the credit situation for the last 24 months.

Cheques Rechazados

Method to obtain the rejected checks with their corresponding reasons.

from bcraapi import centraldeudores

df = centraldeudores.cheques_rechazados(30717283186)

Args

Parameter Type Description
identificacion str Corresponds to CUIT/CUIL/CDI, it must be 11 characters long.

Returns

DataFrame with the rejected checks with their corresponding reasons.

API Documentation:

About

BCRA Wrapper in Python: A Python wrapper to easily retrieve data from the BCRA in Pandas format using the official API.

Topics

Resources

License

Stars

Watchers

Forks

Languages