# Apartments.com (/docs/apartments) Search Apartments.com rental buildings, then read one building with its rents by bedroom count, specials and rating Apartments.com lists rental buildings across the United States. These endpoints read an Apartments.com search link and return its buildings, and read one building in full. Every building uses the canonical `Place` shape: its lowest rent sits in `place.ext.listing`, the same shape Zillow and Redfin homes use, and the rents by bedroom count, the current special and the amenities in `place.ext.apartments`. Base URL: `/v1/apartments/...` Apartments.com exposes 2 routes here. ## Quickstart ### Search an area Copy an Apartments.com search link and pass it as `url`. Price, bedroom and amenity filters in the link are kept. ```bash title="cURL" curl "https://www.socialcrawl.dev/v1/apartments/search?url=https%3A%2F%2Fwww.apartments.com%2Faustin-tx%2F" \ -H "x-api-key: YOUR_API_KEY" ``` ```json title="Response (trimmed)" { "success": true, "data": { "items": [ { "place": { "id": "940ms65", "name": "Loyola Junction I", "address": "6525 Ed Bluestein Blvd, Austin, TX 78724", "phone": "864-528-1774", "ext": { "listing": { "price": 1353, "currency": "USD", "status": "for_rent", "home_type": "apartment" }, "apartments": { "price_max": 2367, "availability": "in_stock", "rent_by_bedroom": [ { "beds": 1, "beds_text": "1 Bed", "price_from": 1243, "price_text": "$1,243+" } ] } } } } ], "total": 700, "next_cursor": "2" } } ``` ### Read one building Pass the building's link as `url`. It ends in the seven-character listing id, which is also `place.id`. ```bash title="cURL" curl "https://www.socialcrawl.dev/v1/apartments/property?url=https%3A%2F%2Fwww.apartments.com%2Floyola-junction-i-austin-tx%2F940ms65%2F" \ -H "x-api-key: YOUR_API_KEY" ``` ## Questions people ask ### Why are beds and baths null on the listing? A building has many floor plans. `place.ext.listing.price` is the lowest rent in the building, and `place.ext.apartments.rent_by_bedroom` gives the lowest rent for each bedroom count (0 is a studio), with the label as Apartments.com shows it. ### Where are the specials? `place.ext.apartments.specials` carries the building's current offer as listed, for example `2 Months Free`, and is null when there is none. ### Does a building have a rating? The building read returns the star rating and its count in `place.rating` and `place.reviews_count` where the listing shows one. Search rows do not carry it. ## All endpoints **How far back and how deep** Each list returns one page at a time. Send `cursor` for the next page, or `max_items` or `max_pages` to collect several pages in one call. A page size appears only where it has been verified. [How paging works](/docs/pagination.md). | Path | Rows per page | Date window | One call collects | | --- | --- | --- | --- | | `/v1/apartments/search` | about 40 | none | up to 5,000 rows or 50 pages | ## Platform notes **Money is in US dollars, per month.** `place.ext.listing.currency` says so on every row. **40 buildings a page.** Pass the returned `cursor` for the next page of the same search. ## Next steps - [Realtor.com](/docs/realtor.md): Homes for sale and for rent from a search link. - [Zillow](/docs/zillow.md): The same listing shape, with rentals by building.