Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/femueller/python-n26

💵 Unofficial Python client for n26 (Number 26) - https://n26.com/
https://github.com/femueller/python-n26

api bank banking cli command-line-tool n26 number26 python

Last synced: 3 months ago
JSON representation

💵 Unofficial Python client for n26 (Number 26) - https://n26.com/

Host: GitHub
URL: https://github.com/femueller/python-n26
Owner: femueller
License: mit
Archived: true
Created: 2017-03-14T09:20:20.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-10-29T09:17:00.000Z (about 1 year ago)
Last Synced: 2024-07-16T23:39:20.678Z (4 months ago)
Topics: api, bank, banking, cli, command-line-tool, n26, number26, python
Language: Python
Homepage:
Size: 395 KB
Stars: 194
Watchers: 11
Forks: 32
Open Issues: 13
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# N26 Python CLI/API

## 2023-10-29 - Archiving the repository

Today, I am marking this repository as archived, as I am not making use of the API itself anymore.
If you'e interested in taking over the maintenance of the repository, please reach out to me.

[![Build Status](https://github.com/femueller/python-n26/actions/workflows/python-app.yml/badge.svg)](https://github.com/femueller/python-n26/actions/workflows/python-app.yml)
[![PyPI version](https://img.shields.io/github/pipenv/locked/python-version/femueller/python-n26)](https://img.shields.io/github/pipenv/locked/python-version/femueller/python-n26)
[![PyPI version](https://badge.fury.io/py/n26.svg)](https://badge.fury.io/py/n26)
[![Downloads](https://img.shields.io/pypi/dm/n26.svg)](https://img.shields.io/pypi/dm/n26.svg)

[![asciicast](https://asciinema.org/a/260083.svg)](https://asciinema.org/a/260083)

## About

[python-n26](https://github.com/femueller/python-n26) is a Python library and Command Line Interface to request information from N26 bank accounts. You can use it to check your balance from the terminal or include it in your own Python projects.

**Disclaimer:** This is an unofficial community project which is not affiliated with N26 GmbH/N26 Inc.

## Install

```shell
pip3 install n26
wget https://raw.githubusercontent.com/femueller/python-n26/master/n26.yml.example -O ~/.config/n26.yml
# configure username and password
vim ~/.config/n26.yml
```

## Configuration

python-n26 uses [container-app-conf](https://github.com/markusressel/container-app-conf) to provide different options for configuration.
You can place a YAML (`n26.yaml` or `n26.yml`) or TOML (`n26.toml` or `n26.tml`) configuration file in `./`, `~/` or `~/.config/`. Have a look at the [YAML example](n26.yml.example) and [TOML example](n26.tml.example).
If you want to use environment variables:

- `N26_USERNAME`: username
- `N26_PASSWORD`: password
- `N26_DEVICE_TOKEN`: random [uuid](https://de.wikipedia.org/wiki/Universally_Unique_Identifier) to identify the device
- `N26_LOGIN_DATA_STORE_PATH`: optional **file** path to store login data (recommended for cli usage)
- `N26_MFA_TYPE`: `app` will use the paired app as 2 factor authentication, `sms` will use SMS to the registered number.

Note that **when specifying both** environment variables as well as a config file and a key is present in both locations the **enviroment variable values will be preferred**.

## Authentication

### Device Token

Since 17th of June 2020 N26 requires a device_token to differentiate clients. This requires you to specify the `DEVICE_TOKEN`
config option with a UUID of your choice. To generate a UUID you can use f.ex. one of the following options:

Using python:

```python
python -c 'import uuid; print(uuid.uuid4())'
```

Using linux built-in tools:

```shell
> uuidgen
```

Using a website:
[https://www.uuidgenerator.net/](https://www.uuidgenerator.net/)

### 2FA

Since 14th of September 2019 N26 requires a login confirmation (2 factor authentication).

There are two options here:

1. Using the paired phone N26 app to approve login on devices that are not paired. This can be configured by setting `app` as the `mfa_type`. You will receive a notification on your phone when you start using this library to request data. python-n26 checks for your login confirmation every 5 seconds. If you fail to approve the login request within 60 seconds an exception is raised.
2. Using a code delivered via SMS to your registered phone number as 2 factor authentication. This can be configured by setting `sms` as the `mfa_type`.

If you do not specify a `login_data_store_path` this login information is only stored in memory. In order to avoid that every CLI command requires a new confirmation, the login data retrieved in the above process can be stored on the file system. Please note that **this information must be protected** from the eyes of third parties **at all costs**. You can specify the location to store this data in the [Configuration](#Configuration).

## Usage

### CLI example

```shell
> n26 balance
123.45 EUR
```

Or if using environment variables:

```bash
> N26_USER=user N26_PASSWORD=passwd N26_DEVICE_TOKEN=00000000-0000-0000-0000-000000000000 N26_MFA_TYPE=app n26 balance
123.45 EUR
```

### JSON output

If you would like to work with the raw `JSON` rather than the pretty table
layout you can use the global `-json` parameter:

```bash
> n26 -json balance
{
"id": "12345678-1234-1234-1234-123456789012",
"physicalBalance": null,
"availableBalance": 123.45,
"usableBalance": 123.45,
"bankBalance": 123.45,
"iban": "DE12345678901234567890",
"bic": "NTSBDEB1XXX",
"bankName": "N26 Bank",
"seized": false,
"currency": "EUR",
"legalEntity": "EU",
"users": [
{
"userId": "12345678-1234-1234-1234-123456789012",
"userRole": "OWNER"
}
],
"externalId": {
"iban": "DE12345678901234567890"
}
}
```

### Docker

```shell
# ensure the n26 folder exists
mkdir ~/.config/n26
# mount the config and launch the command
sudo docker run -it --rm \
-v "/home/markus/.config/n26.yaml:/app/n26.yaml" \
-v "/home/markus/.config/n26:/.config/n26" \
-u 1000:1000 \
femueller/python-n26
```

### API example

```python
from n26.api import Api
api_client = Api()
print(api_client.get_balance())
```

This is going to use the same mechanism to load configuration as the CLI tool, to specify your own configuration you can use it as:

```python
from n26.api import Api
from n26.config import Config

conf = Config(validate=False)
conf.USERNAME.value = "[email protected]"
conf.PASSWORD.value = "$upersecret"
conf.LOGIN_DATA_STORE_PATH.value = None
conf.MFA_TYPE.value = "app"
conf.validate()

api_client = Api(conf)
print(api_client.get_balance())
```

## Contribute

If there are any issues, bugs or missing API endpoints, feel free to contribute by forking the project and creating a Pull-Request.

### Run locally

Prerequirements: [Pipenv](https://pipenv.readthedocs.io/)

```shell
git clone [email protected]:femueller/python-n26.git
cd python-n26
pipenv shell
pipenv install
python3 -m n26 balance
```

### Creating a new release (only for maintainers)

1. Increment version number in `n26/__init__.py` according to desired [SemVer](https://semver.org/#summary) release version
2. Create a new release using the `Makefile`. This creates a new git tag, which triggers the "Upload Python Package" GitHub Action.
1. Run `make git-release`, this triggers: [https://github.com/femueller/python-n26/actions/workflows/python-publish.yml]()
2. New releases end up at: [https://pypi.org/project/n26/]()

## Maintainers

- [Markus Ressel](https://github.com/markusressel)
- [Felix Mueller](https://github.com/femueller)

## Credits

- [Nick Jüttner](https://github.com/njuettner) for providing [the API authentication flow](https://github.com/njuettner/alexa/blob/master/n26/app.py)
- [Pierrick Paul](https://github.com/PierrickP/) for providing [the API endpoints](https://github.com/PierrickP/n26/blob/develop/lib/api.js)

## Similar projects

- Go: https://github.com/guitmz/n26 by [Guilherme Thomazi Bonicontro](https://github.com/guitmz)
- Go: https://github.com/njuettner/n26 by [Nick Jüttner](https://github.com/njuettner) (unmaintained)
- Node https://github.com/PierrickP/n26 by [Pierrick Paul](https://github.com/PierrickP/) (unmaintained)

## Disclaimer

This project is not affiliated with N26 GmbH/N26 Inc. if you want to learn more about it, visit https://n26.com/.

We've been trying [hard to collaborate with N26](https://github.com/femueller/python-n26/issues/107#issuecomment-1008825746) however, it's been always really challenging.
There is no guarantee that this project continues to work at any point, since none of the API endpoints are really documented.