Golang library for querying and parsing OFX

Aaron Lindsay ebf7f5b757 Update xml module 2 weeks ago
cmd/ofx detect_settings: Add newer APPVER's for 'QWIN' APPID 9 months ago
samples Work around missing blank line after last header 6 months ago
.travis.yml Remove old cover tool installer 2 weeks ago
LICENSE Add license 2 years ago
README.md Add BasicClient, update Client to be interface 9 months ago
bank.go Bank transactions: Allow transaction currencies to be empty 4 months ago
bank_test.go Omit end tags for encoding OFX 100-series requests 2 weeks ago
basic_client.go Support carriage returns on new lines 3 weeks ago
client.go Support carriage returns on new lines 3 weeks ago
common.go Support carriage returns on new lines 3 weeks ago
common_test.go go vet 2 years ago
constants.go Switch to copy of encoding/xml with only that subdirectory 1 year ago
constants_test.go go fmt 1 year ago
creditcard.go Switch to copy of encoding/xml with only that subdirectory 1 year ago
creditcard_test.go Add the ability to marshal a Response to SGML/XML and test it 4 months ago
discovercard_client.go Add Hack for Discover 9 months ago
doc.go Update/improve documentation 2 years ago
generate_constants.py go fmt 1 year ago
go.mod Update xml module 2 weeks ago
go.sum Update xml module 2 weeks ago
invstmt.go Add the ability to marshal a Response to SGML/XML and test it 4 months ago
invstmt_test.go Add the ability to marshal a Response to SGML/XML and test it 4 months ago
leaf_elements.go Omit end tags for encoding OFX 100-series requests 2 weeks ago
profile.go Add the ability to marshal a Response to SGML/XML and test it 4 months ago
profile_test.go Add the ability to marshal a Response to SGML/XML and test it 4 months ago
request.go Omit end tags for encoding OFX 100-series requests 2 weeks ago
request_test.go Omit end tags for encoding OFX 100-series requests 2 weeks ago
response.go Support carriage returns on new lines 3 weeks ago
response_test.go Add the ability to marshal a Response to SGML/XML and test it 4 months ago
seclist.go Add the ability to marshal a Response to SGML/XML and test it 4 months ago
signon.go Switch to copy of encoding/xml with only that subdirectory 1 year ago
signon_test.go Add BasicClient, update Client to be interface 9 months ago
signup.go Switch to copy of encoding/xml with only that subdirectory 1 year ago
signup_test.go Add the ability to marshal a Response to SGML/XML and test it 4 months ago
types.go Switch to copy of encoding/xml with only that subdirectory 1 year ago
types_test.go go fmt 1 year ago
util.go Switch to copy of encoding/xml with only that subdirectory 1 year ago
vanguard_client.go Make Client an interface instead of a struct 9 months ago

README.md

OFXGo

Go Report Card Build Status Coverage Status GoDoc

OFXGo is a library for querying OFX servers and/or parsing the responses. It also provides an example command-line client to demonstrate the use of the library.

Goals

The main purpose of this project is to provide a library to make it easier to query financial information with OFX from the comfort of Golang, without having to marshal/unmarshal to SGML or XML. The library does not intend to abstract away all of the details of the OFX specification, which would be difficult to do well. Instead, it exposes the OFX SGML/XML hierarchy as structs which mostly resemble it. Its primary goal is to enable the creation of other personal finance software in Go (as it was created to allow me to fetch OFX transactions for my own project, MoneyGo).

Because the OFX specification is rather... 'comprehensive,' it can be difficult for those unfamiliar with it to figure out where to start. To that end, I have created a sample command-line client which uses the library to do simple tasks (currently it does little more than list accounts and query for balances and transactions). My hope is that by studying its code, new users will be able to figure out how to use the library much faster than staring at the OFX specification (or this library's API documentation). The command-line client also serves as an easy way for me to test/debug the library with actual financial institutions, which frequently have 'quirks' in their implementations. The command-line client can be found in the cmd/ofx directory of this repository.

Library documentation

Documentation can be found with the go doc tool, or at https://godoc.org/github.com/aclindsa/ofxgo

Example Usage

The following code snippet demonstrates how to use OFXGo to query and parse OFX code from a checking account, printing the balance and returned transactions:

client := ofxgo.BasicClient{} // Accept the default Client settings

// These values are specific to your bank
var query ofxgo.Request
query.URL = "https://secu.example.com/ofx"
query.Signon.Org = ofxgo.String("SECU")
query.Signon.Fid = ofxgo.String("1234")

// Set your username/password
query.Signon.UserID = ofxgo.String("username")
query.Signon.UserPass = ofxgo.String("hunter2")

uid, _ := ofxgo.RandomUID() // Handle error in real code
query.Bank = append(query.Bank, &ofxgo.StatementRequest{
	TrnUID: *uid,
	BankAcctFrom: ofxgo.BankAcct{
		BankID:   ofxgo.String("123456789"),   // Possibly your routing number
		AcctID:   ofxgo.String("00011122233"), // Possibly your account number
		AcctType: ofxgo.AcctTypeChecking,
	},
	Include: true, // Include transactions (instead of only balance information)
})

response, _ := client.Request(&query) // Handle error in real code

// Was there an OFX error while processing our request?
if response.Signon.Status.Code != 0 {
	meaning, _ := response.Signon.Status.CodeMeaning()
	fmt.Printf("Nonzero signon status (%d: %s) with message: %s\n", response.Signon.Status.Code, meaning, response.Signon.Status.Message)
	os.Exit(1)
}

if len(response.Bank) < 1 {
	fmt.Println("No banking messages received")
	os.Exit(1)
}

if stmt, ok := response.Bank[0].(*ofxgo.StatementResponse); ok {
	fmt.Printf("Balance: %s %s (as of %s)\n", stmt.BalAmt, stmt.CurDef, stmt.DtAsOf)
	fmt.Println("Transactions:")
	for _, tran := range stmt.BankTranList.Transactions {
		currency := stmt.CurDef
		if ok, _ := tran.Currency.Valid(); ok {
			currency = tran.Currency.CurSym
		}
		fmt.Printf("%s %-15s %-11s %s%s%s\n", tran.DtPosted, tran.TrnAmt.String()+" "+currency.String(), tran.TrnType, tran.Name, tran.Payee.Name, tran.Memo)
	}
}

Requirements

OFXGo requires go >= 1.9

Using the command-line client

To install the command-line client and test it out, you may do the following:

$ go get -v github.com/aclindsa/ofxgo/cmd/ofx && go install -v github.com/aclindsa/ofxgo/cmd/ofx

Once installed (at ~/go/bin/ofx by default, if you haven't set $GOPATH), the command's usage should help you to use it (./ofx --help for a listing of the available subcommands and their purposes, ./ofx subcommand --help for individual subcommand usage).