Rentometer API 

Release Notes

Last updated:  09/18/2020

Overview

We are excited to announce the release of the first version of our Application Programming Interface (API). The Rentometer API allows our customers to access Rentometer data electronically also known as “system-to-system.”  

The new API allows our customers to “call” Rentometer rent data on an as-needed basis and seamlessly incorporate it into their systems and applications.

The Rentometer API is only available to our PRO Standard subscribers.  Each PRO Standard subscription will include 500 API Credits (one API Credit = one API Call). Additional API Credits can be purchased according to the pricing table below.

Getting Started

The following steps will help you get started with the Rentometer API:

1.  Log into your PRO Standard account.  Note: If you do not have a PRO Standard subscription then you can sign up here: www.rentometer.com/pricing

2.  Once logged into your PRO Standard account, visit the Rentometer API settings page here:  https://www.rentometer.com/rentometer-api/settings

3.  Click on the "Terms of Use" link to review and acknowledge the Terms of Use.  Once the Terms of Use are acknowledged, then your API key will be generated.

Once you have your API key, you are ready to go.  The Rentometer API settings page provides the input parameters required, input samples, and output samples.  You can also monitor your API Credit balance and purchase additional API Credits from the Rentometer API settings page.

Terms of Use

Our Terms of Use have been updated to accommodate new provisions for the Rentometer API.  All PRO Standard customers that download an API Key for the Rentometer API will be required to acknowledge and agree to the Rentometer Terms of Use including the provisions related to the Rentometer API.  The Rentometer Terms of Use can be found here:  https://www.rentometer.com/pages/terms-of-use

Pricing

The Rentometer API will be a feature that is available to all our PRO Standard subscribers. 

Each PRO Standard subscription will include 500 API Credits.  One (1) API Credit = one (1) API Call.

Additional API Credits can be purchased according to the price schedule below.

Rentometer API Pricing Table     ***Release Special:  50% more API Credits – FREE!***

API Input Requirements

The Rentometer API will allow customers to request rent statistics for a specific address.  The address request must be fully formed and zip codes, neighborhoods, intersections, and other partial addresses may not return accurate or desired results. 

Usage example

Endpoint: https://www.rentometer.com/api/v1/summary

Calling the Rentometer API is straightforward, as shown in the javascript examples below. Available parameters are as follows:

Param Meaning
api_key Your API key.
address
—OR—
latitude,
longitude
Address or lat/lng describing the center point of analysis.
bedrooms Number of bedrooms. Valid values are: 1, 2, 3, or 4.
baths
optional
Restrict listings to those with only 1 bathroom or 1.5+. Valid values are: blank, "1", or "1.5+".
Note: not all listings include this information and may be excluded from the results.
building_type
optional
Restrict listings to Apartments/Condos or Houses/Duplexes. Valid values are: blank, "apartment", or "house".
Note: not all listings include this information and may be excluded from the results.

Request/Response (cURL)


$ curl "https://www.rentometer.com/api/v1/summary?api_key=YOUR-API-KEY&address=15%20broad%20st.,%20boston,%20ma&bedrooms=2&baths=1.5%2B"

{"address":"15 Broad Street, Boston, Massachusetts 02109","latitude":"42.358737","longitude":"-71.054801","bedrooms":2,"baths":"1.5+","building_type":"Any","mean":4950,"median":4507,"min":3200,"max":8900,"percentile_25":3966,"percentile_75":5935,"std_dev":1459,"samples":21,"radius_miles":0.2,"quickview_url":"https://www.rentometer.com/analysis/2-bed/15-broad-street-boston-massachusetts-02109/pw7q-w28AMM/quickview","credits_remaining":477}

Request (Javascript/JQuery)

jQuery.ajax({
    url: "https://www.rentometer.com/api/v1/summary",
    type: "GET",
    data: {
        "api_key": "YOUR-API-KEY",
        "address": "15 broad st., boston, ma",
        "bedrooms": "2",
    },
})
.done(function(data, textStatus, jqXHR) {
    console.log("HTTP Request Succeeded: " + jqXHR.status);
    console.log(data);
})
.fail(function(jqXHR, textStatus, errorThrown) {
    console.log("HTTP Request Failed");
})
.always(function() {
    /* ... */
});

Response

{
  "address": "15 Broad Street, Boston, Massachusetts 02109",
  "latitude": "42.358737",
  "longitude": "-71.054801",
  "bedrooms": 2,
  "baths": "Any",
  "building_type": "Any",
  "mean": 4327,
  "median": 3750,
  "min": 600,
  "max": 9500,
  "percentile_25": 2891,
  "percentile_75": 5764,
  "std_dev": 2129,
  "samples": 65,
  "radius_miles": 0.5,
  "quickview_url": "https://www.rentometer.com/analysis/2-bed/15-broad-street-boston-massachusetts-02109/H-KF1MIWdIM/quickview",
  "credits_remaining": 459
}

Request (Javascript/JQuery)

jQuery.ajax({
    url: "https://www.rentometer.com/api/v1/summary",
    type: "GET",
    data: {
        "api_key": "YOUR-API-KEY",
        "bedrooms": "2",
        "baths": "1.5+",
        "building_type": "house",
        "latitude": "42.3587",
        "longitude": "-71.0548",
    },
})
.done(function(data, textStatus, jqXHR) {
    console.log("HTTP Request Succeeded: " + jqXHR.status);
    console.log(data);
})
.fail(function(jqXHR, textStatus, errorThrown) {
    console.log("HTTP Request Failed");
})
.always(function() {
    /* ... */
});

Response

{
  "address": null,
  "latitude": "42.3587",
  "longitude": "-71.0548",
  "bedrooms": 2,
  "baths": "1.5+",
  "building_type": "House",
  "mean": 6133,
  "median": 6500,
  "min": 3500,
  "max": 9500,
  "percentile_25": 4820,
  "percentile_75": 7447,
  "std_dev": 1946,
  "samples": 7,
  "radius_miles": 2.0,
  "quickview_url": "https://www.rentometer.com/analysis/2-bed/1-central-st-boston-ma-02109/EKYXT745sWo/quickview",
  "credits_remaining": 458
}

 

Please contact us at feedback@rentometer.com if you have additional questions or would like more information.

Thank you.

The Rentometer Team.