Skip to content

robbiegal/Buxfer-Python-API-Client

Repository files navigation

Buxfer Python API Client

----------- Attention! --------------

THIS IS NOT AN OFFICIAL BUXFER.COM API

----------- Attention! --------------

How this repo was created

  1. Created the "Buxfer API.yaml" file using the Swagger Editor based on the Buxfer API documentation
  2. Generated python client library using the Swagger Editor
  3. Created the "Buxfer_API_usage_example.py" file based on the auto-generated example, and modified it to work a bit better.

Notes:

  1. Only some of the calls are implemented.
  2. The Buxfer official documentation is lacking and outdated, so the implemtation is not identical to the actual responses received in the API calls.

Auto Generated Notes

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 0.0.1
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements

Python 2.7 and 3.4+. Additional requirements in the requirements.txt document.

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/robbiegal/Buxfer-Python-API-Client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/robbiegal/Buxfer-Python-API-Client.git)

Then import the package:

import swagger_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then:

  1. change the data in "personal data.py" to your personal information there:

    buxfer_username = "username"
    buxfer_password = "password"
    
  2. run Buxfer_API_usage_example.py.

Documentation for API Endpoints

All URIs are relative to https://www.buxfer.com/api/

Class Method HTTP request Description
GetDataApi accounts_get GET /accounts Get Accounts information
GetDataApi budgets_get GET /budgets Get Budgets information
GetDataApi contacts_get GET /contacts Get Contacts information
GetDataApi groups_get GET /groups Get Groups information
GetDataApi loans_get GET /loans Get Loans information
GetDataApi reminders_get GET /reminders Get Reminders information
GetDataApi tags_get GET /tags Get Tags information
GetDataApi transactions_get GET /transactions Get Transactions information
LoginApi login_post POST /login Login to website.

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

robbiegal@gmail.com

About

An unofficial, partial implementation of a python client library for Buxfer API using swagger OpenAPI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors