bcra-api-client


Namebcra-api-client JSON
Version 1.2.0 PyPI version JSON
download
home_pageNone
SummaryConsumo de datos de la API del banco central de la Republica Argentina
upload_time2024-05-07 11:20:10
maintainerNone
docs_urlNone
authorNone
requires_python>=3.0
licenseNone
keywords argentina data api bcra client
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # BCRA Client Python

![pypi version](https://img.shields.io/pypi/v/bcra-api-client?style=flat&label=pypi%20package&color=green)

Consumo de datos de la API del Banco Central de la República Argentina (BCRA)

Esta librería está construida con base en la documentación presentada por la misma entidad en el siguiente [link](https://www.bcra.gob.ar/BCRAyVos/catalogo-de-APIs-banco-central.asp).

## Instalar

Debe usar pip para instalar o actualizar a la última versión estable.
```
pip install -U bcra-api-client
```

## Como usar
Su uso es simple, se debe crear primero un cliente a la API.

**Nota**: Hasta ahora la API tiene dos endpoints de estadísticas.

## Cliente API
```python
from bcra import Client

client = Client()
```

## Configurar el Cliente
Se pueden cambiar las configuraciones de un cliente de la siguiente manera: 
```python
from bcra import ConfigClient, Client

config = ConfigClient(language='es')

client = Client(config)
```

### Referencias

- #### language: 
Los idiomas configurados actualmente “es-AR” y “en-US”. De no informar dicho
parámetro, la respuesta se realizará por defecto en “es-AR”.

Los valores admitidos son “es” referenciando a “es-AR” o “en” a “en-US”.


## Principales variables
Para obtener la lista de todas las variables publicadas por el BCRA.
```python
statistics = client.statistics
print(statistics.variables())
```

## Datos de Variable
Para obtener los valores para la variable y el rango de fechas indicadas.

Se debe llamar al mismo método con los siguientes parámetros (id_variable, from_, to)

Donde: 

- **id_variable**: (Int) Se obtiene de consultar a la lista de todas las variables
- **from_**: (String) Corresponde a la fecha de inicio del rango a consultar, la misma deberá tener el formato yyyy-mm-dd
- **to**: (String) Corresponde a la fecha de fin del rango a consultar, la misma deberá tener el formato yyyy-mm-dd

```python
statistics = client.statistics
print(statistics.variables(5, '2024-01-01', '2024-05-01'))
```

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "bcra-api-client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.0",
    "maintainer_email": null,
    "keywords": "Argentina, data, api, BCRA, client",
    "author": null,
    "author_email": "Emmanuel Paiva <none@email.com>",
    "download_url": "https://files.pythonhosted.org/packages/ab/44/8540928c2c35748f3a23644ee0964d736a1d8e272dd467635d65dd66cceb/bcra_api_client-1.2.0.tar.gz",
    "platform": null,
    "description": "# BCRA Client Python\n\n![pypi version](https://img.shields.io/pypi/v/bcra-api-client?style=flat&label=pypi%20package&color=green)\n\nConsumo de datos de la API del Banco Central de la Rep\u00fablica Argentina (BCRA)\n\nEsta librer\u00eda est\u00e1 construida con base en la documentaci\u00f3n presentada por la misma entidad en el siguiente [link](https://www.bcra.gob.ar/BCRAyVos/catalogo-de-APIs-banco-central.asp).\n\n## Instalar\n\nDebe usar pip para instalar o actualizar a la \u00faltima versi\u00f3n estable.\n```\npip install -U bcra-api-client\n```\n\n## Como usar\nSu uso es simple, se debe crear primero un cliente a la API.\n\n**Nota**: Hasta ahora la API tiene dos endpoints de estad\u00edsticas.\n\n## Cliente API\n```python\nfrom bcra import Client\n\nclient = Client()\n```\n\n## Configurar el Cliente\nSe pueden cambiar las configuraciones de un cliente de la siguiente manera: \n```python\nfrom bcra import ConfigClient, Client\n\nconfig = ConfigClient(language='es')\n\nclient = Client(config)\n```\n\n### Referencias\n\n- #### language: \nLos idiomas configurados actualmente \u201ces-AR\u201d y \u201cen-US\u201d. De no informar dicho\npar\u00e1metro, la respuesta se realizar\u00e1 por defecto en \u201ces-AR\u201d.\n\nLos valores admitidos son \u201ces\u201d referenciando a \u201ces-AR\u201d o \u201cen\u201d a \u201cen-US\u201d.\n\n\n## Principales variables\nPara obtener la lista de todas las variables publicadas por el BCRA.\n```python\nstatistics = client.statistics\nprint(statistics.variables())\n```\n\n## Datos de Variable\nPara obtener los valores para la variable y el rango de fechas indicadas.\n\nSe debe llamar al mismo m\u00e9todo con los siguientes par\u00e1metros (id_variable, from_, to)\n\nDonde: \n\n- **id_variable**: (Int) Se obtiene de consultar a la lista de todas las variables\n- **from_**: (String) Corresponde a la fecha de inicio del rango a consultar, la misma deber\u00e1 tener el formato yyyy-mm-dd\n- **to**: (String) Corresponde a la fecha de fin del rango a consultar, la misma deber\u00e1 tener el formato yyyy-mm-dd\n\n```python\nstatistics = client.statistics\nprint(statistics.variables(5, '2024-01-01', '2024-05-01'))\n```\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Consumo de datos de la API del banco central de la Republica Argentina",
    "version": "1.2.0",
    "project_urls": {
        "Homepage": "https://github.com/paivae/BCRA-client-python",
        "Issues": "https://github.com/paivae/BCRA-client-python/issues"
    },
    "split_keywords": [
        "argentina",
        " data",
        " api",
        " bcra",
        " client"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0a6f3ab0e1c45221f935a184a981f949b970afa6a781ed6ccc787a2ad6e141a5",
                "md5": "64c743c2895e3e76e11f0430d8cc67f4",
                "sha256": "0a6978bd788d78cb921de4fb254f875af2931472676f3b93176b56531f20a655"
            },
            "downloads": -1,
            "filename": "bcra_api_client-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "64c743c2895e3e76e11f0430d8cc67f4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.0",
            "size": 7475,
            "upload_time": "2024-05-07T11:20:08",
            "upload_time_iso_8601": "2024-05-07T11:20:08.626664Z",
            "url": "https://files.pythonhosted.org/packages/0a/6f/3ab0e1c45221f935a184a981f949b970afa6a781ed6ccc787a2ad6e141a5/bcra_api_client-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ab448540928c2c35748f3a23644ee0964d736a1d8e272dd467635d65dd66cceb",
                "md5": "ddc2408491294f191948b8580d58927f",
                "sha256": "b5464929b644a11a51f6c5e0ae9b7caeb894919cc89a81c736212db689c64d63"
            },
            "downloads": -1,
            "filename": "bcra_api_client-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ddc2408491294f191948b8580d58927f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.0",
            "size": 6282,
            "upload_time": "2024-05-07T11:20:10",
            "upload_time_iso_8601": "2024-05-07T11:20:10.379597Z",
            "url": "https://files.pythonhosted.org/packages/ab/44/8540928c2c35748f3a23644ee0964d736a1d8e272dd467635d65dd66cceb/bcra_api_client-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-07 11:20:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "paivae",
    "github_project": "BCRA-client-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "bcra-api-client"
}
None
Elapsed time: 0.24744s