/simplifiapi

An unofficial API for Quicken Simplifi

Primary LanguagePythonMIT LicenseMIT

simplifiapi

An unofficial API for Quicken Simplifi

Install

PyPI is temporarily down. Install with pip from GitHub directly

pip3 install git+https://github.com/rijn/simplifiapi

CLI

This package provides a command-line tool that could access and save data to local files.

usage: simplifiapi [-h] [--email [EMAIL]] [--password [PASSWORD]] [--token [TOKEN]] [--accounts] [--transactions] [--tags] [--categories] [--filename FILENAME] [--format {json,csv}]

optional arguments:
  -h, --help            show this help message and exit
  --email [EMAIL]       The e-mail address for your Quicken Simplifi account
  --password [PASSWORD]
                        The password for your Quicken Simplifi account
  --token [TOKEN]       Use existing token to bypass MFA check
  --accounts            Retrieve accounts
  --transactions        Retrieve transactions
  --tags                Retrieve tags
  --categories          Retrieve categories
  --filename FILENAME   Write results to file this prefix
  --format {json,csv}   The format used to return data.

examples:
> simplifiapi --token="..." --transactions
> simplifiapi --token="..." --transactions --filename=20231125 --format=csv

Python API

The Client class allows accessing from python script and making custom analysis.

from simplifiapi.client import Client

client = Client()

# Provide either token or email/password
token = "..."
token = client.get_token(email=options.email, password=options.password)

assert client.verify_token(token)

# Datasets own transactions and accounts
datasets = client.get_datasets()
datasetId = datasets[0]["id"]

# Access transactions
transactions = client.get_transactions(datasetId)

Thanks

This library is heavily inspired by mintapi.