OFXHome Web API
---------------
Other programs may communicate with OFX Home using a web-based API. Data is returned in a simple XML format.
License
-------
Use of the OFXHome Web API is free to non-commercial and open source applications. Please contact info@ofxhome.com for more information.
Searching
---------
The following query will search for institutions that have a name containing "term":
http://www.ofxhome.com/api.php?search=term
The following query will return all institutions:
http://www.ofxhome.com/api.php?all=yes
Both of the previous queries will return data in the following format:
...
Any institution matching the query terms will be returned. If no institutions match then InstitutionList will contain no entries.
Looking up insitution data
--------------------------
The following query will look up institution data:
http://www.ofxhome.com/api.php?lookup=424
Data is returned in the following format
American Express
3101
AMEX
https://www99.americanexpress.com/...
0
0
2007-03-13 23:18:21
2007-03-13 23:18:32
Full dump
--------------------------
A full dump of the OFX Home database may be obtained with the query:
http://www.ofxhome.com/api.php?dump=yes
All institutions in the database will be returned.
Interpreting validation
-----------------------
The ofxfail and sslfail fields will be 0 if the last attempt at validation succeeded and non-zero if the last validation attempt failed. This does not necesarily mean that the information for the institution is invalid. It only means that the most recent attempt to validate was unsuccessful. It is possible that the validation failed for a number of legitimate reasons such as a network outage, a server was down, etc. If either ofx or ssl validation failed then the failure should be interpreted in light of the last validation date.
The lastofxvalidation and lastsslvalidation fields contain the last date that ofx and ssl passed validation, respectively. If the dates are within a few days of the current date then everything is likely in order. If the last successful validation was several days old then there could be a problem.
Notes
-----
Some institutions have notes that are returned in the "notes" field. Notes are returned as a single field. Multiple notes are separated by a newline "\n" character.
Deleted Institutions
--------------------
Deleted institutions will not appear in full dumps or search results. Deleted institutions will still return data when looked up by id (api.php?lookup=123).
Change History
--------------
Version 1.0.0, June 5th, 2011
- Api is available at http://ofxhome.com/api100.php
- Added encoding="utf-8" tag to xml content
Version 1.1.0, December 1st, 2011
- Api is available at http://ofxhome.com/api110.php
- Added dump=yes option to return a copy of the full database
- Added profile information for servers that provide it
Version 1.1.1, September 9, 2012
- Api is available at http://ofxhome.com/api111.php
- Added notes
Version 1.1.2, March 10, 2018
- Added ability to delete duplication institutions
The most current API is always available at http://www.ofxhome.com/api.php