n26-puppeteer-scraper/README.md

n26 scraper: a tool to download account informations and transactions archive

## n26-puppeteer-scraper

cli to get information about your n26 account, statements and transactions from n26.com (until we'll have an official api).

by default it shows the browser window so that you can observe what's going on. you can disable this feature though, see [headless-mode](#headless-mode)

for usage, see **[cli section](#cli)**

## install

```
npm i -g n26-puppeteer-scraper
```

### headless mode

pass the option `--headless` to hide the browser window while scraping to any command

e.g.

```bash
n26-puppeteer-scraper ... --headless
```

# cli

## account

### info

get info on your bank account

```bash
n26-puppeteer-scraper account info --username 'YOUR_EMAIL' --password 'YOUR_PASSWORD'
```

## statements

### list

list bank statements

```bash
n26-puppeteer-scraper statements list --username 'YOUR_EMAIL' --password 'YOUR_PASSWORD'
```

### download

download bank statements to `statements` folder

```bash
n26-puppeteer-scraper statements download --username 'YOUR_EMAIL' --password 'YOUR_PASSWORD'
```

## transactions

### archive

*optionally specify start and end date*

dates must be passed as 10 character strings in the format 'YYYY-MM-DD'.

the default start date is set to a month before the current date.

the default end date is set to the current date.

e.g.:

```bash
n26-puppeteer-scraper transactions archive --username 'YOUR_EMAIL' --password 'YOUR_PASSWORD' \
  --start '2018-01-01' \
  --end '2020-01-01'
```

# telegram notification (totally optional)

you can enable the notification via telegram message by setting the environment variables

- telegram_token
- telegram_user_id

the program will notify when the login session starts, ideally before the n26 confirmation popup appears.