Apartments.com Search

Search Apartments.com listings from a search URL.

GET/api/v1/apartments/search

Alpha: this endpoint is new and its response fields may still change.

Costs 1 credit per request; failed requests are refunded. Authentication, the search_metadata envelope and error codes are the same as for every endpoint (see the API reference). Try it in the playground.

Parameters

Request parameters

Search Apartments.com listings from a search URL.

Parameter	Type	Description
`url`required	string	Apartments.com location search URL, including any price, bedroom, amenity or page filters.Up to 4,096 characters.Alpha: availability may vary by location or property.Use the site URL to set filters or select a page. Follow pagination.next when present. Page links and total counts are included when available.Prices may represent a rental range. Bedroom-specific rents and total-monthly-price labels are preserved when present.

Response

A JSON object with search_metadata (request id, credits used and remaining) and the result data: properties. Groups and fields depend on the content of each page, so treat every field as optional.

Examples

cURL

curl "https://serpfast.com/api/v1/apartments/search?url=https%3A%2F%2Fwww.apartments.com%2Faustin-tx%2F" \
  -H "Authorization: Bearer $SERPFAST_KEY"

Node.js 18+

const params = new URLSearchParams({
  "url": "https://www.apartments.com/austin-tx/"
});
const res = await fetch(`https://serpfast.com/api/v1/apartments/search?${params}`, {
  headers: { Authorization: `Bearer ${process.env.SERPFAST_KEY}` },
});
const data = await res.json();
console.log(data);

Python

import os, requests

params = {
  "url": "https://www.apartments.com/austin-tx/"
}
res = requests.get(
    "https://serpfast.com/api/v1/apartments/search",
    params=params,
    headers={"Authorization": f"Bearer {os.environ['SERPFAST_KEY']}"},
    timeout=120,
)
print(res.json())