Rentometer API 2.0

Audience

The Rentometer API documentation is intended for programmers who want to write client applications that interact with Rentometer. Users who work only with the Outbound API, which enables client applications to easily access Rentometer data through a web browser, should be familiar with HTML.  Users of the Inbound API, which allows client applications to post and manage listings on the Rentometer should be familiar with the  HTTP protocol, XML, and common tools for accessing HTTP servers such as cURL or wget.   Examples in this document will be given using cURL.

Rentometer API Terminology

Rental Data Search

Rental Data Search (Search) is the process of searching for comparable rental statistics and listing information based on a set of client inputs, in a similar manner to the way the Rentometer Web Application works. The Outbound API (see blow) handles Search and a number of different search algorithms are supported. In general, Outbound API Search results will differ somewhat from Rentometer Web Application results.  

Rental Statistics

Rental Statistics are generated by the Outbound API and include the low (20%), median (50%), high (80%) current rental rates for the area specified for the Rental Data Search. Results depend on the algorithm used for the search and location (as specified by the search parameters) and the rental statistics may therefore not agree with the Rentometer Web Application results, which may use a different algorithm.

Outbound API

The Outbound API is used to perform Rental Data Search. Users need to obtain an Outbound API Key to access the Outbound API. The Outbound API Key will not work for the Inbound API.  Outbound API Search results are returned in a number of formats, including XML, JSON, or PNG. 

Rental Listings

Both the Inbound and Outbound API make use of Rental Listings which are used to describe information about rental units. The data is always expressed in XML. The XML used is a simplified, non-standard version.  Client applications post rental information to the Rentometer using the Inbound API. 

Inbound API

The Inbound API is used to post Rental Listings to the Rentometer andmanage posted listing. Users need to obtain an Inbound API Key to access the Inbound API.  Inbound API client applications only have access to their own data and can not perform Rental Data Search through this interface. 

Inbound API Key, Outbound API Key

All Rentometer API users need to obtain either an Inbound API Key, or Outbound API Key, or both keys. No access will be granted without a valid key and other access control restrictions may be in place to limit service abuse.