OFXHome Web API
---------------

Other programs may communicate with OFX Home using a web-based API.  The OFXHome Web API hould be considered as under development and is subject to change at any moment.

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:

    <?xml?>
    <institutionlist>
    <institutionid name="American Express" id=1234/>
    <institutionid name="Bank of America" id=2222/>
    ...
    </institutionlist>
    
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=1234
    
Data is returned in the following format

    <?xml?>
    <Institution id=1234>
    <name>American Express</name>
    <fid>3101</fid>
    <org>AMEX</org>
    <url>https://www99.americanexpress.com/...</url>
    <brokerid></brokerid>
    <ofxfail>0</ofxfail>
    <sslfail>0</sslfail>
    <lastofxvalidation>2007-03-13 23:18:21</lastofxvalidation>
    <lastsslvalidation>2007-03-13 23:18:32</lastsslvalidation>
    </Institution>
    
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.