GET — Rental Data
If you're looking for information on rental properties in the US real estate market, you're in the right place. Our read-only API provides access to a comprehensive database of rental properties, offering details like rental price, number of bedrooms, bathrooms, square footage, and more. Whether you're a developer building an app or just someone on the hunt for the perfect rental, we've got you covered.
URL
https://api.ratespot.io/v1/rental_data
Authentication
To get started with this endpoint, you will need a valid, active RateSpot account and an API key. Please refer back to the Authentication section for more information on how to create an account and get an API key.
Once you have an API key, you should pass it to the endpoint by including it as a query parameter called apikey
in the URL every time you make a request:
https://api.ratespot.io/v1/rental_data?apikey=YOUR_API_KEY
Query Parameters
This endpoint accepts the following filters as URL query parameters:
Parameter | Type | Required | Multiple | Accepted Values |
---|---|---|---|---|
apikey | string | yes | no | Your RateSpot API key |
zipcode | number | no | no | Any valid US zip code |
rental_low | number | no | no | Any positive number |
rental_max | number | no | no | Any positive number |
baths | number | no | no | Any positive number |
beds | number | no | no | Any positive number |
sqft | number | no | no | Any positive number |
date | string | no | no | Any valid date in the format YYYY-MM-DD |
Pagination Parameters
This endpoint accepts the following pagination parameters as URL query parameters:
Parameter | Type | Required | Multiple | Accepted Values |
---|---|---|---|---|
limit | number | no | no | Any natural number starting from 10 |
offset | number | no | no | Any natural number |
Setting a limit lower than 10
will result in the API falling back to 10
.
Examples
Get rental data from Cleveland (44105
)
The following examples show how to retrieve rental data from Cleveland, Ohio (44105
).
- Bash
- Python
curl "https://api.ratespot.io/v1/rental_data?apikey=YOUR_API_KEY&zipcode=44105"
import requests # pip install requests
ENDPOINT = "https://api.ratespot.io/v1/rental_data"
params = {
"apikey": "YOUR_API_KEY",
"zipcode": 44105,
}
response = requests.get(ENDPOINT, params=params)
print(response.json())
{
"data": [
{
"address": "13400 Crennell Ave",
"agent": "Leasing",
"agent_phone": 4404659645,
"baths": "1",
"beds": "3",
"broker": null,
"city": "Cleveland",
"country": "Cuyahoga County",
"date": "Sat, 09 Dec 2023 20:50:14 GMT",
"description": "Recently updated. 3 bedrooms 1 bath. Colonial home. Corlett Neighborhood. Washer and dryer hookups as well as stove and fridge hookups. Tenants are responsible for electric, gas, and water. Available immediately. Pets OK $50/month fee per pet with a 2 pet max. \nRecently updated. 3 bedrooms 1 bath. Colonial home. Corlett Neighborhood. Washer and dryer hookups as well as stove and fridge hookups. Tenants are responsible for electric, gas, and water. Available immediately. Pets OK $50/month fee per pet with a 2 pet max.",
"is_per_person": false,
"kind": "SingleFamily",
"lat": 41.44981,
"long": -81.58888,
"neighborhood": "Corlett",
"phone": 4404659645,
"photo": "https://images1.apartments.com/i2/y5_f8H_IhE0jnvwi498L4qLzmEbrTihMS_lnFC52uIk/111/13400-crennell-ave-cleveland-oh-primary-photo.jpg?p=1",
"rental_low": 1195,
"rental_max": 0,
"sqft": "1,072",
"state": "Ohio",
"url": "https://www.apartments.com/13400-crennell-ave-cleveland-oh/k6c8nyc/",
"zipcode": 44105
}
// ... 9 more results
],
"error": null,
"message": null,
"results": {
"current_page": 1,
"next_page": "https://api.ratespot.io/v1/rental_data?apikey=YOUR_API_KEY&zipcode=44105&rental_low=None&rental_max=None&baths=None&sqft=None&date=None&limit=10&offset=2",
"pages": 1568,
"results_per_page": 10,
"total": 15679
}
}
Get rental data from Cleveland (44105
) with a minimum rental price of $1,000
and a maximum rental price of $2,000
The following examples show how to retrieve rental data from Cleveland, Ohio (44105
) with a minimum rental price of $1,000
and a maximum rental price of $2,000
.
- Bash
- Python
curl "https://api.ratespot.io/v1/rental_data?apikey=YOUR_API_KEY&zipcode=44105&rental_low=1000&rental_max=2000"
import requests # pip install requests
ENDPOINT = "https://api.ratespot.io/v1/rental_data"
params = {
"apikey": "YOUR_API_KEY",
"zipcode": 44105,
"rental_low": 1000,
"rental_max": 2000,
}
response = requests.get(ENDPOINT, params=params)
print(response.json())
{
"data": [
{
"address": "13400 Crennell Ave",
"agent": "Leasing",
"agent_phone": 4404659645,
"baths": "1",
"beds": "3",
"broker": null,
"city": "Cleveland",
"country": "Cuyahoga County",
"date": "Mon, 11 Dec 2023 20:49:07 GMT",
"description": "Recently updated. 3 bedrooms 1 bath. Colonial home. Corlett Neighborhood. Washer and dryer hookups as well as stove and fridge hookups. Tenants are responsible for electric, gas, and water. Available immediately. Pets OK $50/month fee per pet with a 2 pet max. \nRecently updated. 3 bedrooms 1 bath. Colonial home. Corlett Neighborhood. Washer and dryer hookups as well as stove and fridge hookups. Tenants are responsible for electric, gas, and water. Available immediately. Pets OK $50/month fee per pet with a 2 pet max.",
"is_per_person": false,
"kind": "SingleFamily",
"lat": 41.44981,
"long": -81.58888,
"neighborhood": "Corlett",
"phone": 4404659645,
"photo": "https://images1.apartments.com/i2/y5_f8H_IhE0jnvwi498L4qLzmEbrTihMS_lnFC52uIk/111/13400-crennell-ave-cleveland-oh-primary-photo.jpg?p=1",
"rental_low": 1195.0,
"rental_max": 0.0,
"sqft": "1,072",
"state": "Ohio",
"url": "https://www.apartments.com/13400-crennell-ave-cleveland-oh/k6c8nyc/",
"zipcode": 44105
}
// ... 999 more results
],
"error": null,
"message": null,
"results": {
"current_page": 1,
"next_page": "https://apidev.ratespot.io/v1/rental_data?apikey=YOUR_API_KEY&zipcode=44105&rental_low=1000.0&rental_max=2000.0&baths=None&sqft=None&date=None&limit=1000&offset=2",
"pages": 8,
"results_per_page": 1000,
"total": 7624
}
}
Schemas
This endpoint comes with a standard JSON response schema that fits with most applications. This section describes the response schema and the fields included in the response data object.
Response data schema
The response data object contains the following fields:
Field | Type | Description |
---|---|---|
data | array | A list of properties for rent. |
error | string | An error message, if there is one. |
message | array | A list of event messages, if there are any. |
results | object | Information about the results, such as the current page, next page URL, total number of pages, and total number of results. |
Property Schema
Each property included in the data
array contains the following fields:
Field | Type | Description |
---|---|---|
address | string | The property address. |
agent | string | The agent name. |
agent_phone | number | The agent phone number. |
baths | string | The number of bathrooms. |
beds | string | The number of bedrooms. |
broker | string | The broker name. |
city | string | The city name. |
country | string | The country name. |
date | string | The date the property was listed. |
description | string | The property description. |
is_per_person | bool | Whether the rental price is per person. |
kind | string | The property type. |
lat | number | The property latitude. |
long | number | The property longitude. |
neighborhood | string | The neighborhood name. |
phone | number | The property phone number. |
photo | string | The property photo URL. |
rental_low | number | The minimum rental price. |
rental_max | number | The maximum rental price. |
sqft | string | The property square footage. |
state | string | The state name. |
url | string | The property URL. |
zipcode | number | The property zip code. |