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.