Skip to main content

Python client for the bunq public API

Project description

# bunqclient
Python client for the bunq public API

![Code Climate](
![BCH compliance](

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

The latest unreleased version can be installed from GitHub:
git clone
cd ./bunqclient
python 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.

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

from bunqclient import BunqClient
bunq_sandbox = BunqClient(base="",

``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 (``_``).

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 (6.4 kB view hashes)

Uploaded source

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