Skip to content
This repository has been archived by the owner on Apr 27, 2023. It is now read-only.

bartbroere/bunqclient

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Now archived and not maintained. Check out the official Python SDK for the Bunq API instead: https://github.com/bunq/sdk_python


bunqclient

Python client for the bunq public API.

Build status Code Climate Release Pre-release Licence Versions

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.

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.

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

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.