Skip to main content

Python client for the bunq public API

Project description

# bunqclient
Python client for the bunq public API

![Code Climate](https://codeclimate.com/github/bartbroere/bunqclient.svg)
![BCH compliance](https://bettercodehub.com/edge/badge/bartbroere/bunqclient?branch=master)
![Release](https://img.shields.io/pypi/v/bunqclient.svg)
![Licence](https://img.shields.io/pypi/l/bunqclient.svg)
![Versions](https://img.shields.io/pypi/pyversions/bunqclient.svg)

## Installation
Installing the latest release can be done from PyPi:
```
pip install bunqclient
```

The latest unreleased version can be installed from GitHub:
```
git clone https://github.com/bartbroere/bunqclient/
cd ./bunqclient
python setup.py install
```

## Usage
Before using it, make sure that you understand the cost scheme of this API.
Replace the value of the parameter ``secret`` with the API key generated in
the bunq app.

```python
from bunqclient import BunqClient
bunq = BunqClient(secret="")
```

To use the sandbox version change the ``base`` parameter. Note that you should
use a separate API key for this. A sandbox key can be acquired by asking bunq
support.

```python
from bunqclient import BunqClient
bunq_sandbox = BunqClient(base="https://sandbox.public.api.bunq.com/v1",
secret="")
```

``LIST`` requests are basically ``GET`` requests without a specified key. The
first two API calls have the same effect. The third requests a specific
``monetary-account``. Due to the way Python interprets variable names, dashes
(``-``) in API methods and keys should be replaced with underscores (``_``).

```python
bunq.request(method="LIST", monetary_account="", user=1)
bunq.request(method="GET", monetary_account="", user=1)
bunq.request(method="GET", monetary_account=11, user=1)
```

These API calls return a python dictionary with the query's result.

## Contributing
To report bugs and submit feature requests, please open an issue on GitHub.
Pull requests that resolve issues or TODO's are also greatly appreciated.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bunqclient-2017.7.17.zip (6.4 kB view details)

Uploaded Source

File details

Details for the file bunqclient-2017.7.17.zip.

File metadata

  • Download URL: bunqclient-2017.7.17.zip
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for bunqclient-2017.7.17.zip
Algorithm Hash digest
SHA256 a34d1a51485522281cc66a8c3b21f84554f9061493e9918eb96b8f1b0a751145
MD5 7f6d55788e771469cfe11537d6c4c682
BLAKE2b-256 6d35ed9daf219fc9c6e8471b10a82d57739520e8dd10f93d64a2036f2497850e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page