Apartments Scraper API
Extract structured property data from public Apartments pages as JSON. Send a listing URL and receive the fields exposed by the target page.
Decide before you build
- Endpoint
- POST /scrape/real-estate
- Scrapers
- Apartments property listing pages
- Cost
- from 1 credit / call
- Free plan
- 1,000 credits / month
- Call pattern
- sync, POST
- On failure
- credits refunded
- Response format
- JSON
- Concurrency
- by plan tier
Real Estate requests are synchronous. Cost depends on the options selected for the request.
Try the Apartments scraper on your own targetRun a request against a public property listing page and inspect the JSON before you integrate.
Open the live testWhat you get back
property dataApartments data in JSON
Retrieve the property information exposed by the public Apartments page.
- Listing title, description and images
- Price, currency and property type when available
- Location, surface area and room details
- Agency and listing publication data when available
Request optionsControl how the page is collected
Use rendering or proxy options only when the target requires them.
- JavaScript rendering with useChrome
- Premium proxy and country targeting
- Public URL input; no account login required
- Structured JSON in the same response
Call the Apartments scraper
Send a public listing URL to the Real Estate endpoint. The API returns the result in the same response.
# POST - scrape a public property listing page
curl -X POST "https://api.scraping-bot.io/scrape/real-estate" \
-u "yourUsername:yourApiKey" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/listing/123",
"options": {
"useChrome": false,
"premiumProxy": false
}
}'Code example
Authenticate with your ScrapingBot username and API key, then read the returned JSON.
const auth = "Basic " + Buffer.from("yourUsername:yourApiKey").toString("base64");
const response = await fetch("https://api.scraping-bot.io/scrape/real-estate", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: auth },
body: JSON.stringify({ url: "https://example.com/listing/123", options: { useChrome: false, premiumProxy: false } }),
});
const result = await response.json();Run this call in two minutesCreate an account, copy your API key, then use the example above.
Get your API keyRequest parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
url | string | — | Full public page URL, including https://. |
options.useChrome | boolean | false | Render JavaScript when the target page requires a browser. |
options.premiumProxy | boolean | false | Use a premium proxy for targets that require it. |
options.proxyCountry | string | — | Country targeting with a premium proxy. |
Response example
Example returned by the legacy Apartments scraper documentation.
{
"data": {
"title": "67 Franklin St, New York, NY 10013 - Condo for Rent in New York, NY | Apartments.com",
"description": "See all available condos for rent at 67 Franklin St in New York, NY. 67 Franklin Sthas rental units starting at $65000. ",
"parcelSurfaceArea": null,
"surfaceAreaUnit": "Square Feet",
"price": null,
"currency": "USD",
"numberOfRooms": null,
"numberOfBedrooms": "5",
"publishingDate": "Today",
"monthlyRent": "$65,000",
"weeklyRent": null,
"marketedBy": {
"phoneNumber": "tel:9172094550",
"websiteUrl": "https://corcoran.com/listing/for-rent/67-franklin-street-phw-manhattan-ny-10013/22994396/regionId/1",
"languages": "",
"todaysHours": "",
"logo": "https://images1.apartments.com/i2/3eJDJ1yCrjx8yN3_hOfwla0FO1YoBk_vJZweBfLmeeM/110/image.jpg"
},
"energyClass": null,
"greenhouseGazClass": null,
"buildYear": null,
"postalCode": "10013",
"city": "New York",
"image": "https://images1.apartments.com/i2/HTUv_yX1pZnEz4iohXMA8jjI06mgZpCo0PHNsFapLw0/111/67-franklin-st-new-york-ny-primary-photo.jpg?p=1",
"insulation": null,
"siteURL": "https://www.apartments.com/67-franklin-st-new-york-ny/kdbjq49/",
"siteHtml": null,
"statusCode": 200,
"htmlLength": 172659,
"captchaFound": false,
"isHtmlPage": true,
"host": "www.apartments.com",
"numberOfBathrooms": "5",
"neighborhood": {
"name": "Tribeca",
"description": "Zoned in the shape of a trapezoid, Tribeca means “Triangle Below Canal Street,” and is known for its industrial warehouses that have been renovated as sophisticated lofts (and happen to be popular with many celebrities). Full of world-class dining and retail, the neighborhood is ultra-chic, containing an array of luxury, waterfront apartments available for rent.Tribeca is known for being an elegant escape from the bustle of city life. In addition to its tree-lined streets and lush landscaping, Tribeca draws many families for its close proximity to Hudson Park and many award-winning public schools.If you enjoy being able to get what you want when you want it, then you’ll be glad to know that Tribeca shops, eateries, and bars are open even later than most in the rest of Manhattan. However, you won’t find a crazy nightlife scene. Late nights in Tribeca tend to be more low-key.The neighborhood hosts the famous Tribeca Film Festival every year."
},
"state": "New York",
"road": "",
"rating": {
"value": null,
"total": null,
"reviewsCount": null,
"comment": ""
},
"numberOfPhoto": "32 Photos",
"numberOfVirtualTour": "",
"numberOfVideo": "",
"pricing": [],
"about": {
"description": "AS FEATURED IN ARCHITECTURAL DIGEST MAGAZINEThis designer penthouse with 5+ bedrooms, 5 baths and 4 terraces brings breezy California-style living to the NYC skyline by seamlessly blending the indoors with the outdoors, creating a new standard of urban zen luxury living. With an ode to Japanese American heritage, the Osaka-style showplace customized by AD acclaimed designer Sebastian Zuchowicki, is a true sanctuary in the sky.Step off your key-locked elevator into the formal entry and prepare to be captivated as you turn the corner into the expansive open living space featuring 20-foot ceilings, beautiful white oak and radiant heated limestone floors, and double-height windows inviting natural light to flood every corner of the home offering panoramas of the cityscape.Enjoy seamless indoor/outdoor living, courtesy of sliding glass walls that fully retract to create an open living environment that is both breathtaking and functional. 4 privates terraces spanning a combined 1,431 square feet, offer an oasis of tranquility, providing the perfect setting for al fresco dining, entertaining, sunbathing, or even cultivating your own urban garden while enjoying the vibrant energy of the city below. A custom dog run creates ease and convenience for pet owners and offers a lush retreat for their furry friends as well.The well-appointed kitchen features an eat-in waterfall island, custom white matte lacquer cabinets, Bianco Oro countertops, and a suite of fully integrated Gaggenau appliances. Beyond the living area lies a secluded home office with a walk-in closet and en-suite bathroom, offering a peaceful retreat for work or relaxation. Additionally, a guest bedroom with convenient access to a second full bathroom is nestled discreetly behind the kitchen.On the upper level, a dramatic hallway overlooking the living room leads to the primary suite-a luxurious retreat featuring two windowed walk-in closets, a private terrace, and a lavish en-suite bathroom with a Corian double vanity, radiant heated marble floors, walk-in shower, and a freestanding Kaldewei soaking tub. The second and third bedrooms offer ample closet space and share access to a chic terrace, accompanied by two additional bathrooms-one with a shower and the other with a soaking tub. A full laundry room with a utility sink, Miele washer, and vented dryer offers additional convenience.Originally built in 1881, The Cast Iron House has been transformed by Pritzker Prize winner Shigeru Ban into a striking boutique condominium with only 13 residences. Its exceptional amenities include a 24-hour doorman, a state-of-the-art fitness center designed by The Wright Fit, a dance/yoga studio, a hydrotherapy spa, a steam and sauna room, a children's playroom, bicycle storage, and a Green Wall courtyard.67 Franklin St is a condo located in Manhattan County and the 10013 ZIP Code. This area is served by the New York City Geographic District # 2 attendance zone.",
"uniqueFeatures": []
},
"amenities": {
"communityAmenities": {
"communityFeatures": [],
"otherFeatures": [
{
"name": "",
"features": [
"Air Conditioning",
"Hardwood Floors",
"Furnished",
"Package Service",
"Laundry Facilities",
"Controlled Access",
"Fitness Center"
]
},
{
"name": "",
"features": [
"Air Conditioning",
"Hardwood Floors",
"Furnished",
"Package Service",
"Laundry Facilities",
"Controlled Access",
"Fitness Center"
]
}
]
},
"apartementAmenities": {
"apartementFeatures": [],
"otherFeatures": []
}
},
"fees": {
"feesPolicies": [],
"details": [
{
"name": "",
"values": []
},
{
"name": "Lease Options",
"values": [
"12 Months"
]
},
{
"name": "Property Information",
"values": [
"Furnished"
]
}
]
},
"education": {
"colleges": {
"colleges": [
{
"name": "New York Law School",
"collegeUrl": "https://www.apartments.com/off-campus-housing/ny/new-york/new-york-law-school/",
"typeOfDeplacement": "Walk",
"time": "4 min",
"distance": "0.2 mi"
}
],
"description": "67 Franklin St is within 4 minutes or 0.2 mile from New York Law School. It is also near Boro. of Manhattan Comm. Coll. and Pace University, New York City."
},
"schools": {
"publicSchools": [
{
"name": "Spruce Street School",
"schoolUrl": "https://www.apartments.com/schools/ny/spruce-street-school/mf46c2j/",
"level": "Public Elementary & Middle School",
"grades": "Grades PK-8",
"students": "492 Students",
"nearby": "Attendance Zone",
"schoolScore": {
"value": 9,
"total": 10
}
}
],
"privateSchools": [
{
"name": "Portfolio School",
"schoolUrl": "https://www.apartments.com/schools/ny/portfolio-school/b6rebjc/",
"level": "Private Elementary & Middle School",
"grades": "Grades K-7",
"students": "",
"nearby": "Nearby",
"schoolScore": {
"value": null,
"total": null
}
}
]
}
},
"transportation": {
"description": "Transportation options available in New York include Canal Street (N,Q,R Line), located 0.2 miles from 67 Franklin St. 67 Franklin St is near Laguardia, located 10.1 miles or 22 minutes away, and Newark Liberty International, located 12.3 miles or 19 minutes away.",
"transport": [
{
"name": "Transit / Subway",
"details": [
{
"name": "Canal Street (N,Q,R Line)",
"url": "https://www.apartments.com/transit/ny/new-york/canal-street-nqr-line/c9tmb3e/",
"typeOfDeplacement": "Walk",
"time": "3 min",
"distance": "0.2 mi"
}
]
},
{
"name": "Commuter Rail",
"details": [
{
"name": "Flatbush Avenue Station",
"url": "https://www.apartments.com/transit/ny/brooklyn/flatbush-avenue-station/k4077c8/",
"typeOfDeplacement": "Drive",
"time": "8 min",
"distance": "3.1 mi"
}
]
},
{
"name": "Airports",
"details": [
{
"name": "Laguardia",
"typeOfDeplacement": "Drive",
"time": "22 min",
"distance": "10.1 mi"
}
]
}
],
"scores": [
{
"name": "Walk Score®",
"value": "Walker's Paradise",
"score": 99,
"total": 100,
"comment": "Lace up your walking shoes because this area is considered a walker’s paradise."
},
{
"name": "Transit Score®",
"value": "Rider's Paradise",
"score": 100,
"total": 100,
"comment": "Living in this area is considered a rider’s paradise, with world-class transportation."
},
{
"name": "Bike Score®",
"value": "Very Bikeable",
"score": 87,
"total": 100,
"comment": "This area is very Bikeable. You’ll find a variety of bike paths and lanes."
}
]
},
"pointOfInterest": [
{
"name": "Shopping Centers",
"description": "67 Franklin St has 3 shopping centers within 1.3 miles, which is about a 4-minute drive. The miles and minutes will be for the farthest away property.",
"details": [
{
"name": "Westfield World Trade Center",
"url": "https://www.apartments.com/malls/ny/new-york/westfield-world-trade-center/2rck53c/",
"typeOfDeplacement": "Walk",
"time": "13 min",
"distance": "0.7 mi"
}
]
},
{
"name": "Parks and Recreation",
"description": "67 Franklin St has 5 parks within 1.6 miles, including City Hall Park, Merchant's House Museum, and Hudson River Park.",
"details": [
{
"name": "City Hall Park",
"typeOfDeplacement": "Walk",
"time": "5 min",
"distance": "0.3 mi"
}
]
}
],
"reviews": [],
"gallery": [],
"nearby": [
{
"apartmentUrl": "https://www.apartments.com/90-schuyler-ave-kearny-nj-unit-2/x0zpswq/",
"image": "https://images1.apartments.com/i2/7H6UqNPFlw1hR0WBu0lwdEzuznODQD9HlvcG8_J58fI/118/90-schuyler-ave-unit-2-kearny-nj-building-photo.jpg",
"name": "",
"address": "90 Schuyler AveKearny, NJ 07032",
"numberOfBedrooms": "4 Br",
"priceRange": "$3,100",
"distance": "7.8 mi"
}
],
"frequentlyAskedQuestion": []
}
}Credits, failures and limits
| Case | Credits | Notes |
|---|---|---|
| Standard request | from 1 credit / call | Current plans start at this rate. |
| JavaScript rendering | Additional credits | Enable only when the target requires it. |
| Premium proxy | Additional credits | Use for targets that require a premium proxy. |
| Unsuccessful request | Not deducted | Only successful requests count towards the monthly limit. |
Real Estate API or Raw HTML scraper?
| Real Estate API | Raw HTML scraper | |
|---|---|---|
| Endpoint | /scrape/real-estate | /scrape/raw-html |
| Returns | Structured property JSON | Rendered page HTML |
| Flow | One synchronous request | One synchronous request |
| Starting cost | from 1 credit / call | from 1 credit / call |
| Use it when | You need parsed property fields | You need your own extraction logic |
Questions about the Apartments API
- Does the Apartments scraper access private data?
- No. This guide covers public property listing pages and does not require signing in to a Apartments account.
- Are all fields always available?
- No. Returned data depends on what the public Apartments page exposes and what the extractor supports.
- Can I collect multiple pages at once?
- Each request takes one public URL. Submit one request per page you need to collect.
- When should I use a premium proxy?
- Use it only when a target requires it or when you need country targeting for a public page.
Source: ScrapingBot API documentation.
Other real estate scrapers
Browse the Real Estate category for the complete list of guides, or visit the ScrapingBot blog for implementation guides.
Trusted by developers using Real Estate data.
Customer reviews apply to ScrapingBot's service overall, not specifically to this scraper.
Start scraping Apartments today
1,000 free credits every month. No card required, cancel anytime.
