HOME-ACCOUNT API

The Home-Account API lets you query and customize Home-Account Mortgage
Center (http://www.home-account.com/mortgagecenter) assets from your own
web page, including your applications.



Sample Widget Here is an example of an API Widget customized by Movoto to fit
their branding.

Try Now!


http://www.home-account.com/api/bestrate?pid=0&outputType=JSON&productType=conforming30

APIs


  1. Loan Affordability
  2. Rent v/s Buy Recommendation
  3. Best Rate

Introduction


All API calls are based on REST architecture. Data is returned in the XML and JSON formats in order to enable easy integration with a variety of languages and applications.

The widgets showcased on our Mortgage Center (http://www.home-account.com/mortgagecenter) are using the APIs. Please use the HTML/JavaScript code displayed in the text area on the page to customize the functionality and the user interface for these widgets to suit your color template. Additional customization is available by contacting api@home-account.com


API calls work both on regular HTTP as well the more secure HTTPS.

Requirements


Each API call requires a unique partner identifier (pid) which can be obtained by contacting us at api@home-account.com . Without the partner identifier, we will not be able to report and attribute visitors from your site.

Executing API commands


  1. Build the URL using partner identifier and choose your output format.
    http://www.home-account.com/api/
    <command>?pid=<partner_identifier>&outputType=<json|xml>&<input1>=<v1>&...
  2. Download that URL using a standard HTTP GET request. Most languages have high-level functions that will do this for you (you might consider fopen() if you're using PHP or XMLHttpRequest if you're using Javascript).
  3. Decode the JSON/XML response. Most languages have a function to do this (take a look at json_decode()
    in PHP    ).
  4. Check the API responses to detect errors reported by the call.

Please keep checking back on this page (http://www.home-account.com/static/apidoc.html). We are in process of developing more APIs, including ones that provide access to the members-only sections of our product.