Property Search
/api/oneroof/search
Search property for sale, rent or sold
Scrappa's OneRoof API returns structured JSON from OneRoof, a New Zealand property marketplace. Search homes for sale, rent and recently sold with region, suburb, bedroom, bathroom, carpark, price, land and floor area filters, open a listing for photos, valuation, schools and suburb data, find place ids by name, and read agent and agency profiles.
Try it now
Use the first endpoint in this API family with a Scrappa API key. Every account includes 500 free monthly credits, so you can validate the response shape before buying credits.
curl -X GET "https://scrappa.co/api/oneroof/search?type=sale®ion_id=35&bedrooms=3,4&sort=latest" \
-H "Accept: application/json" \
-H "X-API-KEY: YOUR_API_KEY"
{
"success": true,
"data": {
"items": [
{
"id": 2540878,
"url": "https://www.oneroof.co.nz/property/auckland/onehunga/66-trafalgar-street/rN6Ox",
"listing_type": "sale",
"property_type": "House",
"price_text": "Auction",
"price": null,
"currency": "NZD",
"bedrooms": 7,
"bathrooms": 4,
"land_area_sqm": 797,
"address": { "full": "66 Trafalgar Street, Onehunga, Auckland City, Auckland", "latitude": -36.916478, "longitude": 174.7748438 }
}
],
"excluded_by_filters": 0,
"pagination": { "page": 1, "per_page": 40, "total_items": 9856, "total_pages": 247, "next_page": 2 }
},
"meta": { "endpoint_family": "search", "billable": true }
}
Structured data for real applications. Here are some ideas.
Track asking prices, rents and sold prices by region, suburb, bedrooms and category across Auckland, Wellington, Christchurch and more.
Page through filtered searches of up to 50 listings per page and open each listing for its photos, valuation and history.
List every listing of an agency or an agent, with agency and agent profiles, sales statistics and serviced suburbs.
Plot listings, sold properties and schools on a map with latitude and longitude per item.
OneRoof scraper API
The OneRoof API is built for real-estate analytics, listing tools and market research. Each search item carries the price text with a numeric price when the site shows one, bedrooms, bathrooms, carparks, land and floor area, address with coordinates, photos with room labels, open homes, agents and the agency. Listing detail adds the description, features, valuation, history, schools, crime level and suburb statistics.
One search route for sale, rent and sold, up to 50 per page.
Filters are always honoured: items that break a filter are never returned.
Pagination returns the real page; a page past the last one is empty, never page 1 under another number.
A valid empty result is a successful, billable response; failures are never billed.
Resolve a suburb name to an id, then pass the ready-made search parameter into search.
Open OneRoof Autocomplete API docsAdd price, bedroom, bathroom, area and agency filters, choose a sort order, then page through the results.
Open OneRoof Search API docsPass the id of a search result to get the description, valuation, schools, suburb data and agents.
Open OneRoof Listing API docsEverything you need in one API.
/api/oneroof/search
Search property for sale, rent or sold
/api/oneroof/listing
Get the full record of one listing by id
/api/oneroof/autocomplete
Find region, suburb, street and school ids by name
/api/oneroof/agent
Get an agent profile with statistics
/api/oneroof/agency
Get an agency profile with counts
See how Scrappa compares to the official API.
| Feature | Scrappa | ScrapingBee / ScraperAPI |
|---|---|---|
| OneRoof listing data as JSON | Build your own parser | |
| Sale, rent and sold in one route | Separate scrapers | |
| Filters guaranteed on every item | Not available | |
| Price per 1k requests | From $0.20 | Varies by plan |
| Unified API key | Yes (80+ APIs) | Scraping only |
| Free tier | 500 credits/month | Trial credits only |
No. Scrappa is an independent service and is not affiliated with or endorsed by OneRoof. The API returns structured JSON from public listing data through a Scrappa API key.
No. Prices shown in words stay text and the numeric price is null. A number is returned only when the site shows one clear amount. Price filters cannot judge word-only prices, so those items are kept.
Sold items from search carry the sold price, method and date. Their detail is not available; the listing route serves sale and rental listings.
No. Only successful responses are billed. A valid empty result is successful and billable.