OneRoof API

OneRoof API for New Zealand Property Search, Rentals, Sold Prices, Listing Details and Agents

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.

500 free credits
No card needed
From $0.20 / 1k
Pay as you go
Structured JSON
Ready for apps
API key access
Test in minutes
5
Endpoints
3
Listing modes (sale, rent, sold)
$0.20
Per 1k requests

Try it now

Make one request. Inspect structured JSON.

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.

Request preview
Request
curl -X GET "https://scrappa.co/api/oneroof/search?type=sale&region_id=35&bedrooms=3,4&sort=latest" \
  -H "Accept: application/json" \
  -H "X-API-KEY: YOUR_API_KEY"
JSON response
{
  "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 }
}

What you can build

Structured data for real applications. Here are some ideas.

New Zealand Price Analysis

Track asking prices, rents and sold prices by region, suburb, bedrooms and category across Auckland, Wellington, Christchurch and more.

Listing Monitoring

Page through filtered searches of up to 50 listings per page and open each listing for its photos, valuation and history.

Agency Research

List every listing of an agency or an agent, with agency and agent profiles, sales statistics and serviced suburbs.

Mapping

Plot listings, sold properties and schools on a map with latitude and longitude per item.

OneRoof scraper API

OneRoof API for New Zealand property listings, rentals and sold prices

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.

Choose the right OneRoof API endpoint

Use Autocomplete to build searches

Resolve a suburb name to an id, then pass the ready-made search parameter into search.

Open OneRoof Autocomplete API docs

Use Property Search for market coverage

Add price, bedroom, bathroom, area and agency filters, choose a sort order, then page through the results.

Open OneRoof Search API docs

Use Listing Detail for the full record

Pass the id of a search result to get the description, valuation, schools, suburb data and agents.

Open OneRoof Listing API docs

Available endpoints

Everything you need in one API.

Scrappa vs ScrapingBee / ScraperAPI

See how Scrappa compares to the official API.

OneRoof listing data as JSON
Scrappa:
ScrapingBee / ScraperAPI: Build your own parser
Sale, rent and sold in one route
Scrappa:
ScrapingBee / ScraperAPI: Separate scrapers
Filters guaranteed on every item
Scrappa:
ScrapingBee / ScraperAPI: Not available
Price per 1k requests
Scrappa: From $0.20
ScrapingBee / ScraperAPI: Varies by plan
Unified API key
Scrappa: Yes (80+ APIs)
ScrapingBee / ScraperAPI: Scraping only
Free tier
Scrappa: 500 credits/month
ScrapingBee / ScraperAPI: Trial credits only

Key features

Search, listing, autocomplete, agent and agency routes as JSON
Sale, rent and sold in one search route with bedroom, bathroom, carpark, category, price and area filters
Price text with a numeric price when one clear amount is shown, coordinates, photos with room labels and open homes
Listing detail with description, valuation, history, schools, crime level and suburb statistics
No browser, no login: public data served through a single Scrappa API key

Frequently asked questions

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.

Start using the OneRoof API

Sign up and get 500 free credits. No credit card required.