Apartments.com Property

Get an Apartments.com property by URL.

GET/api/v1/apartments/property

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

Get an Apartments.com property by URL.

Parameter	Type	Description
`url`required	string	Apartments.com property URL ending in its seven-character listing ID, without query parameters.Up to 2,048 characters.Alpha: availability may vary by location or property.Returns available fields for the requested property.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: property. 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/property?url=https%3A%2F%2Fwww.apartments.com%2Fedison-austin-austin-tx%2F40n18nj%2F" \
  -H "Authorization: Bearer $SERPFAST_KEY"

Node.js 18+

const params = new URLSearchParams({
  "url": "https://www.apartments.com/edison-austin-austin-tx/40n18nj/"
});
const res = await fetch(`https://serpfast.com/api/v1/apartments/property?${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/edison-austin-austin-tx/40n18nj/"
}
res = requests.get(
    "https://serpfast.com/api/v1/apartments/property",
    params=params,
    headers={"Authorization": f"Bearer {os.environ['SERPFAST_KEY']}"},
    timeout=120,
)
print(res.json())