RentRange API Developers Guide
This guide is intended to give developers a functional reference to call and parse rental rate data through the RentRange API.
The API currently provides low, median and high rental rates for an individual property. The engine runs multiple queries to our database to get the smallest search radius which returns an appropriate number of results. If no address is specified, or the address is not found by the geocoder, the engine will return results for the zipcode.
Step 1 - Apply for your API key
Once you have applied for your API Key, you can begin integrating the calls to the API and formatting the output.
Step 2 - Available Parameters
The Rental Rates API accepts the following parameters:
| Param Name | Required | Description |
|---|---|---|
| "key" | Yes | Your API key is necessary in every request |
| "address" | No | You will need to URL encode the address before passing your request |
| "zip" | Yes | Please pass a valid, 5 digit zipcode (city and state are not required) |
| "type" | No | Use either "type=house" or "type=apt" |
| "beds" | Yes | Numeric values only |
Step 3 - Assemble the Request
The following is an example query string to pass via cURL, wget or other file retreival method:
Using REST/HTTP protocol, our API provides resulting data back to you in XML. The most typical methods to send the query and retrieve the XML are:
- cURL
- wget
- file_get_contents (php)
- simplexml_load_file (php)
- and many others depending on your programming language of choice
Step 4 - Retreive and Parse the Data
Below is a sample XML response
<rentrangeAPI> <result_date>2009-11-04T18:17:32-06:00</result_date> <address>123 Elm St</address> <city>Boulder</city> <state>CO</state> <zip>80305</zip> <type>home</type> <latitude>42.340411</latitude> <longitude>-71.09286</longitude> <view_charts>rentrange.com/rental-rates?address=123+Elm..</view_charts> <rent_results>64</rent_results> <rent_radius>1 mi</rent_radius> <rent_low>1450</rent_low> <rent_median>1620</rent_median> <rent_high>1950</rent_high> </rentrangeAPI>
| Results Node Name | Description |
|---|---|
| "result_date" | The timestamp of the request |
| "address" | Address of the target property passed to the API |
| "city" | City name found by our geo-locator |
| "state" | State found by our geo-locator |
| "zip" | Zipcode of the target property |
| "type" | Property type passed to the API. If type not specified, rental rates for apartments will be returned |
| "latitude" | Latitude coordinates of the target property (if found) |
| "longitude" | Longitude coordinates of the target property (if found) |
| "view_charts" | An optional resource link to provide to your clients which shows the results returned in graphical format. Other data is also displayed on this page such as section 8 rental rates in the area, map of the property, and a chart outlining rental rates for both homes and apartments in the area. |
| "rent_results" | Total number of comparable results found for the given parameters, inside the "rent_radius" |
| "rent_radius" | Results returned in Miles, shows the distance of the search to return a significant number of comparables in which to derive results. |
| "rent_low" | Average low rent amount in the search radius, not the lowest rent amount found in the area. |
| "rent_median" | Median rent amount in the area within the given radius. |
| "rent_high" | Average high rent amount in the search radius, not the highest rent amount found in the area. |
Step 5 - Make it Pretty
Now that you have the data, it is time to organize and format the results to best suit the look and feel of your website.
View our branding requirements and logo options
The RentRange API Terms of Use requires that you display the RentRange logo directly adjacent to any RentRange data that you display on your site. Please see the Terms of Use for additional details.
RentRange API Information
