Apartments Search
Search Apartments.com rentals from a full city or browse URL and retrieve prices, photos, addresses, phone numbers, and pagination via browser rendering.
Credit cost: 2 credits per call
Autorisierung
ApiKeyAuth x-api-key<token>
Your API key. Include it in the x-api-key header for every request.
In: header
Abfrageparameter
query*string
Full Apartments.com search or city browse URL.
Example 1 (New York, page 3):
https://www.apartments.com/new-york-ny/3Example 2 (page 1):
https://www.apartments.com/new-york-ny/Notes:
- Only
apartments.comlisting search URLs are accepted. - Copy the full URL from apartments.com, including city slug and page number in the path (
/new-york-ny/3). - Pagination uses the page segment in the URL path (
/2/,/3/, ...).pagination.next_urlpoints to the next page. - Apartments.com search pages are JavaScript SPAs; this endpoint uses website rendering to scrape listing cards.
- Pass each result's
urlto the Apartments Property endpoint for full unit data.
Antworttext
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v2/apartments/search?query=string"{ "results": [ { "id": "p6b4mes", "url": "https://www.apartments.com/141-e-33rd-st-new-york-ny-unit-si-fl16-id43/p6b4mes/", "image": "https://images1.apartments.com/i2/SF9HSqkGqXN0cjmR2cUNbgLuxyXklZLpKYtInYim0XI/118/141-e-33rd-st-unit-si-fl16-id43-new-york-ny-building-photo.jpg?p=1", "phone": "8555266751", "title": "141 E 33rd St Unit SI FL16-ID43", "address": "141 E 33rd St, New York, NY 10016", "pricing": [ { "beds": "2 Beds", "price": "$7,210" } ], "has_video": false, "min_price": 7210, "image_count": 23, "country_code": "US", "property_type": "Apartment for Rent", "street_address": "141 E 33rd St", "has_virtual_tour": true }, { "id": "kkt0hfb", "url": "https://www.apartments.com/53-park-pl-new-york-ny-unit-si-fl3-id53/kkt0hfb/", "image": "https://images1.apartments.com/i2/6wscRtCcX-3nE67ze4o41rAW9_6LCo0nJX22IYicrAk/118/53-park-pl-unit-si-fl3-id53-new-york-ny-building-photo.jpg?p=1", "phone": "8555289504", "title": "53 Park Pl Unit SI FL3-ID53", "address": "53 Park Pl, New York, NY 10007", "pricing": [ { "beds": "Studio", "price": "$5,110" } ], "has_video": false, "min_price": 5110, "image_count": 28, "country_code": "US", "property_type": "Apartment for Rent", "street_address": "53 Park Pl", "has_virtual_tour": true }, { "id": "khk0kyc", "url": "https://www.apartments.com/53-park-pl-new-york-ny-unit-si-fl10-id54/khk0kyc/", "image": "https://images1.apartments.com/i2/P4YtFr_qFvkB4rsy5m33Qw2UUAu-hNz4xmlBmvbum8I/118/53-park-pl-unit-si-fl10-id54-new-york-ny-building-photo.jpg?p=1", "phone": "5512272189", "title": "53 Park Pl Unit SI FL10-ID54", "address": "53 Park Pl, New York, NY 10007", "pricing": [ { "beds": "1 Bed", "price": "$7,190" } ], "has_video": false, "min_price": 7190, "image_count": 31, "country_code": "US", "property_type": "Apartment for Rent", "street_address": "53 Park Pl", "has_virtual_tour": true } ], "pagination": { "current": 3, "next_url": "https://www.apartments.com/new-york-ny/4/", "total_count": 7775, "has_next_page": true }}{ "error": "Bad Request"}{ "error": "Invalid API Key"}{ "error": "Payment required"}{ "error": "Rate limit exceeded for the API key: quota monthly"}{ "error": "Internal Error"}