https://github.com/bradymholt/openbank

A friendly REST service wrapper for OFX bank servers.
https://github.com/bradymholt/openbank

nancyfx ofx ofx-bank-servers

Last synced: 3 months ago
JSON representation

A friendly REST service wrapper for OFX bank servers.

• Host: GitHub
• URL: https://github.com/bradymholt/openbank
• Owner: bradymholt
• Created: 2013-09-13T21:45:38.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2017-03-31T03:11:08.000Z (almost 8 years ago)
• Last Synced: 2024-10-06T08:51:24.290Z (3 months ago)
• Topics: nancyfx, ofx, ofx-bank-servers
• Language: JavaScript
• Homepage:
• Size: 9.3 MB
• Stars: 10
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
OpenBank

========

A friendly REST service wrapper for OFX bank servers.

## Quick Start

1. Download latest release zip file from [https://github.com/bradyholt/OpenBank/releases](https://github.com/bradyholt/OpenBank/releases)  

2. Unzip and run *OpenBank.exe* from command line.  If using mono, run *mono OpenBank.exe* 

3. OpenBank should fire up and now be listening on port 1234, by default.

4. In a browser, navigate to http://localhost:1234/ to ensure OpenBank is running and to get more info.

## Get Transactions Example

To get a list of transactions for a bank account, you'll want to use the **statement** (POST) resource.  The required parameters for this resource are:

Parameter Name | Notes

--- | ---

ofx_url | (obtain from  [OFX Home](http://www.ofxhome.com))

fid | (obtain from  [OFX Home](http://www.ofxhome.com))

org | (obtain from  [OFX Home](http://www.ofxhome.com))

user_id | Your login username

password | Your login password

bank_id | Routing number (leave blank for CREDITCARD accounts)

account_id | Your account number

account_type | CHECKING, SAVING, MONEYMRKT, CREDITCARD, OTHER

date_start | YYYYMMDD format

date_end | YYYYMMDD format

For example - If you have a checking account at Chase, you would use the directory at [OFX Home](http://www.ofxhome.com) to get Chase's OFX information ([direct link](http://www.ofxhome.com/index.php/institution/view/636))

including the ofx_url, fid, and org.  The rest of the paramters should be known by you already.  Using wget, you could download transactions for your Chase account, for date range 9/1/2013 to 9/15/2013, and save as JSON file with the following command:

    wget --header="Accept: application/json" --post-data="ofx_url=https://ofx.chase.com

      &fid=10898&org=B1&user_id=YOUR_USERNAME_HERE&password=YOUR_PASSWORD_HERE&bank_id=111000614

      &account_id=816555555&account_type=CHECKING&date_start=20130901

      &date_end=20130915" http://localhost:1234/statement -O statement.json