Sign inGet a free API keyDashboard
Menu

APIs / Real estate / OneRoof

1 credit per call5 endpoints28 datapoints

OneRoof API

OneRoof API for New Zealand homes for sale, rent and recently sold, listings, agents, agencies and suburb lookup as JSON. 1 credit per successful call.

Get a free API keyRun it below
OneRoof
GET/v1/oneroof/search?type=sale&region_id=35&bedrooms[]=3&bedrooms[]=4&sort=latest
{
  "success": true,
  "data": {
    "items": [
      {
        "id": 2552376,
        "uid": "glOfX",
        "url": "https://www.oneroof.co.nz/property/auckland/howick/lot-1-68-andrew-road/glOfX",
        "slug": "auckland/howick/lot-1-68-andrew-road/glOfX",
        "code": "944131",
        "title": "Developer Says Sell - Must Be Sold!",
        "listing_type": "sale",
        "listing_type_label": "Residential for sale",
        "property_type": "House",
        "category_id": 1,
        "price_text": "By negotiation",
        "currency": "NZD",
        "price_method_code": 2,
        "bedrooms": 4,
        "bathrooms": 2,
        "carparks": 1,
        "address": {
          "full": "Lot 1/68 Andrew Road, Howick, Manukau City, Auckland",
          "street": "Lot 1/68 Andrew Road",
          "suburb": "Howick",
          "suburb_id": 470,
          "district": "Manukau City",
          "district_id": 223,
          "region": "Auckland",
          "region_id": 35,
          "latitude": -36.9068489,
          "longitude": 174.9260712
        },
        "status": 1,
        "listed_at": "2026-11-11T16:00:00Z",
        "is_new_listing": true,
        "is_new_home": false,
        "is_coming_soon": false,
        "images": [
          "https://s.oneroof.co.nz/image/3d/6f/3d6f4a50739046fc788b1c08a50a26a1.jpg?x-oss-process=image/quality,q_80",
          "https://s.oneroof.co.nz/image/5b/8b/5b8bd535335550d0f878ce638dce5f62.jpg?x-oss-process=image/quality,q_80",
          "https://s.oneroof.co.nz/image/83/4f/834f1462f85f7c9dc40c39770caa7889.jpg?x-oss-process=image/quality,q_80"
        ],
        "image_groups": [
          {
            "key": "other room",
            "label": "Others",
            "images": [
              "https://s.oneroof.co.nz/image/3d/6f/3d6f4a50739046fc788b1c08a50a26a1.jpg?x-oss-process=image/quality,q_80",
              "https://s.oneroof.co.nz/image/5b/8b/5b8bd535335550d0f878ce638dce5f62.jpg?x-oss-process=image/quality,q_80",
              "https://s.oneroof.co.nz/image/83/4f/834f1462f85f7c9dc40c39770caa7889.jpg?x-oss-process=image/quality,q_80"
            ]
          }
        ],
        "open_homes": [
          {
            "start": "2026-11-14T01:30:00Z",
            "end": "2026-11-14T02:00:00Z"
          },
          {
            "start": "2026-11-15T01:45:00Z",
            "end": "2026-11-15T02:15:00Z"
          }
        ],
        "agents": [
          {
            "id": 18393,
            "name": "Ella Lin",
            "phone": "021 021 88860",
            "photo": "https://s.oneroof.co.nz/image/b9/0f/b90ff00e52d15f4b89075bb24cf85898.jpg?x-oss-process=image/quality,q_80"
          }
        ],
        "office": {
          "id": 484,
          "name": "Barfoot & Thompson Ltd (Licensed: REAA 2008) - Highland Park",
          "photo": "https://s.oneroof.co.nz/image/c7/6d/c76dd7b88f06e745c62b27b98d5f1e88.jpg?x-oss-process=image/quality,q_80",
          "banner": "https://s.oneroof.co.nz/image/9a/01/9a0168ca52acd05f60736ce7377d459f.jpg?x-oss-process=image/quality,q_80"
        },
        "detail_available": true
      },
      {
        "id": 2552371,
        "uid": "VBtcJ",
        "url": "https://www.oneroof.co.nz/property/auckland/howick/lots-1-5-68-andrew-road/VBtcJ",
        "slug": "auckland/howick/lots-1-5-68-andrew-road/VBtcJ",
        "code": "944130",
        "title": "Developer Says Sell - Must Be Sold!",
        "listing_type": "sale",
        "listing_type_label": "Residential for sale",
        "property_type": "House",
        "category_id": 1,
        "price_text": "By negotiation",
        "currency": "NZD",
        "price_method_code": 2,
        "bedrooms": 4,
        "bathrooms": 2,
        "carparks": 1,
        "address": {
          "full": "Lots 1-5/68 Andrew Road, Howick, Manukau City, Auckland",
          "street": "Lots 1-5/68 Andrew Road",
          "suburb": "Howick",
          "suburb_id": 470,
          "district": "Manukau City",
          "district_id": 223,
          "region": "Auckland",
          "region_id": 35,
          "latitude": -36.9068489,
          "longitude": 174.9260712
        },
        "status": 1,
        "listed_at": "2026-11-11T16:00:00Z",
        "is_new_listing": true,
        "is_new_home": false,
        "is_coming_soon": false,
        "images": [
          "https://s.oneroof.co.nz/image/f3/9b/f39bf2eed0eb0d3b2fea52422e3489c1.jpg?x-oss-process=image/quality,q_80",
          "https://s.oneroof.co.nz/image/ed/ef/edefcbb545ae6f889e907d2b8040137d.jpg?x-oss-process=image/quality,q_80",
          "https://s.oneroof.co.nz/image/5b/8b/5b8bd535335550d0f878ce638dce5f62.jpg?x-oss-process=image/quality,q_80"
        ],
        "image_groups": [
          {
            "key": "other room",
            "label": "Others",
            "images": [
              "https://s.oneroof.co.nz/image/f3/9b/f39bf2eed0eb0d3b2fea52422e3489c1.jpg?x-oss-process=image/quality,q_80",
              "https://s.oneroof.co.nz/image/ed/ef/edefcbb545ae6f889e907d2b8040137d.jpg?x-oss-process=image/quality,q_80",
              "https://s.oneroof.co.nz/image/5b/8b/5b8bd535335550d0f878ce638dce5f62.jpg?x-oss-process=image/quality,q_80"
            ]
          }
        ],
        "open_homes": [
          {
            "start": "2026-11-14T01:30:00Z",
            "end": "2026-11-14T02:00:00Z"
          },
          {
            "start": "2026-11-15T01:45:00Z",
            "end": "2026-11-15T02:15:00Z"
          }
        ],
        "agents": [
          {
            "id": 18393,
            "name": "Ella Lin",
            "phone": "021 021 88860",
            "photo": "https://s.oneroof.co.nz/image/b9/0f/b90ff00e52d15f4b89075bb24cf85898.jpg?x-oss-process=image/quality,q_80"
          }
        ],
        "office": {
          "id": 484,
          "name": "Barfoot & Thompson Ltd (Licensed: REAA 2008) - Highland Park",
          "photo": "https://s.oneroof.co.nz/image/c7/6d/c76dd7b88f06e745c62b27b98d5f1e88.jpg?x-oss-process=image/quality,q_80",
          "banner": "https://s.oneroof.co.nz/image/9a/01/9a0168ca52acd05f60736ce7377d459f.jpg?x-oss-process=image/quality,q_80"
        },
        "detail_available": true
      },
      {
        "id": 2551944,
        "uid": "x9GAv",
        "url": "https://www.oneroof.co.nz/property/auckland/hauraki/325-lake-road/x9GAv",
        "slug": "auckland/hauraki/325-lake-road/x9GAv",
        "code": "944459",
        "title": "Exceptional Design Meets Coastal Convenience",
        "listing_type": "sale",
        "listing_type_label": "Residential for sale",
        "property_type": "Townhouse",
        "category_id": 4,
        "price_text": "By negotiation",
        "currency": "NZD",
        "price_method_code": 2,
        "bedrooms": 3,
        "bathrooms": 2,
        "carparks": 1,
        "floor_area_sqm": 110,
        "floor_area_text": "110m²",
        "address": {
          "full": "325 Lake Road, Hauraki, North Shore City, Auckland",
          "street": "325 Lake Road",
          "suburb": "Hauraki",
          "suburb_id": 3068,
          "district": "North Shore City",
          "district_id": 226,
          "region": "Auckland",
          "region_id": 35,
          "latitude": -36.79776,
          "longitude": 174.7795868
        },
        "status": 1,
        "listed_at": "2026-11-11T16:00:00Z",
        "is_new_listing": true,
        "is_new_home": false,
        "is_coming_soon": false,
        "images": [
          "https://s.oneroof.co.nz/image/77/df/77df14e4a551dc7d5859db2478a9599a.jpg?x-oss-process=image/quality,q_80",
          "https://s.oneroof.co.nz/image/31/20/3120b6d298f1dbe92eb64dbfbd5e6da9.jpg?x-oss-process=image/quality,q_80",
          "https://s.oneroof.co.nz/image/6f/04/6f0441dbdf11553ef7c5473f35cd87bb.jpg?x-oss-process=image/quality,q_80"
        ],
        "image_groups": [
          {
            "key": "living room",
            "label": "Living Room",
            "images": [
              "https://s.oneroof.co.nz/image/31/20/3120b6d298f1dbe92eb64dbfbd5e6da9.jpg?x-oss-process=image/quality,q_80",
              "https://s.oneroof.co.nz/image/6f/04/6f0441dbdf11553ef7c5473f35cd87bb.jpg?x-oss-process=image/quality,q_80",
              "https://s.oneroof.co.nz/image/5d/2d/5d2dcd76a12fc8b7d8f0c9a01cdee06a.jpg?x-oss-process=image/quality,q_80"
            ]
          },
          {
            "key": "kitchen",
            "label": "Kitchen",
            "images": [
              "https://s.oneroof.co.nz/image/6f/04/6f0441dbdf11553ef7c5473f35cd87bb.jpg?x-oss-process=image/quality,q_80",
              "https://s.oneroof.co.nz/image/5d/2d/5d2dcd76a12fc8b7d8f0c9a01cdee06a.jpg?x-oss-process=image/quality,q_80",
              "https://s.oneroof.co.nz/image/3a/95/3a959f63f8d1db3489aa8619d8b55e43.jpg?x-oss-process=image/quality,q_80"
            ]
          },
          {
            "key": "bedroom",
            "label": "Bedroom",
            "images": [
              "https://s.oneroof.co.nz/image/6c/02/6c0226feab367659101459fec513399d.jpg?x-oss-process=image/quality,q_80",
              "https://s.oneroof.co.nz/image/45/05/45059b2fc837400c85822663e69a0944.jpg?x-oss-process=image/quality,q_80",
              "https://s.oneroof.co.nz/image/b7/7e/b77e46181647401a2212dd7ca094f3de.jpg?x-oss-process=image/quality,q_80"
            ]
          }
        ],
        "open_homes": [
          {
            "start": "2026-11-13T21:30:00Z",
            "end": "2026-11-13T22:00:00Z"
          },
          {
            "start": "2026-11-14T21:30:00Z",
            "end": "2026-11-14T22:00:00Z"
          }
        ],
        "agents": [
          {
            "id": 174,
            "name": "Aden Xu",
            "phone": "021 1773 898",
            "photo": "https://s.oneroof.co.nz/image/ce/cb/cecbb825eb812218dc832d4225f304ce.jpg?x-oss-process=image/quality,q_80"
          },
          {
            "id": 81803,
            "name": "Jeremy Mi",
            "phone": "021 229 9808",
            "photo": "https://s.oneroof.co.nz/image/36/19/3619257bbd29c83dbd07571f02a518bf.jpg?x-oss-process=image/quality,q_80"
          }
        ],
        "office": {
          "id": 10237,
          "name": "Barfoot & Thompson Ltd (Licensed: REAA 2008) - Takapuna",
          "photo": "https://s.oneroof.co.nz/image/c7/6d/c76dd7b88f06e745c62b27b98d5f1e88.jpg?x-oss-process=image/quality,q_80",
          "banner": "https://s.oneroof.co.nz/image/9a/01/9a0168ca52acd05f60736ce7377d459f.jpg?x-oss-process=image/quality,q_80"
        },
        "rateable_value": "$1,725,000",
        "building_age": "",
        "detail_available": true
      }
    ],
    "excluded_by_filters": 0,
    "pagination": {
      "page": 1,
      "per_page": 40,
      "total_items": 10298,
      "total_pages": 258,
      "next_page": 2
    }
  },
  "meta": {
    "endpoint_family": "search",
    "request_id": "req_4abe66f323e8455e8fcef4acf35340f4",
    "credits_charged": 1,
    "credits_remaining": 1834
  }
}
200 OKJSONX-Credits-Used: 1
Recorded from our API and shortened.

Sample data

What one call returns

A recorded run of search: the fields and shapes you will get, shortened to 3 items.

#idintegeruidstringurlurlslugstringcodestringtitlestringlisting_typestringlisting_type_labelstringproperty_typestringcategory_idintegerprice_textstringcurrencystringprice_method_codeintegerbedroomsintegerbathroomsintegercarparksintegeraddressobjectstatusintegerlisted_atstringis_new_listingbooleanis_new_homebooleanis_coming_soonbooleanimagesstring[]image_groupsobject[]open_homesobject[]agentsobject[]officeobjectdetail_availableboolean
12552376glOfXhttps://www.oneroof.co.nz/property/auckland/howick/lot-1-68-andrew-road/glOfXauckland/howick/lot-1-68-andrew-road/glOfX944131Developer Says Sell - Must Be Sold!saleResidential for saleHouse1By negotiationNZD2421{10 fields}12026-11-11T16:00:00Ztruefalsefalse[3 items][1 item][2 items][1 item]{4 fields}true
22552371VBtcJhttps://www.oneroof.co.nz/property/auckland/howick/lots-1-5-68-andrew-road/VBtcJauckland/howick/lots-1-5-68-andrew-road/VBtcJ944130Developer Says Sell - Must Be Sold!saleResidential for saleHouse1By negotiationNZD2421{10 fields}12026-11-11T16:00:00Ztruefalsefalse[3 items][1 item][2 items][1 item]{4 fields}true
32551944x9GAvhttps://www.oneroof.co.nz/property/auckland/hauraki/325-lake-road/x9GAvauckland/hauraki/325-lake-road/x9GAv944459Exceptional Design Meets Coastal ConveniencesaleResidential for saleTownhouse4By negotiationNZD2321{10 fields}12026-11-11T16:00:00Ztruefalsefalse[3 items][3 items][2 items][2 items]{4 fields}true

Recorded from our API · 3 items shown · 28 datapoints per itemGET /v1/oneroof/search?type=sale&region_id=35&bedrooms[]=3&bedrooms[]=4&sort=latest

28 datapoints

Identity

  • idinteger
  • uidstring
  • slugstring
  • titlestring
  • listing_typestring
  • listing_type_labelstring
  • property_typestring
  • category_idinteger
  • statusinteger

Contact

  • urlurl
  • agentsobject[]

Location

  • addressobject

Reputation

  • imagesstring[]
  • image_groupsobject[]

Price

  • price_textstring
  • currencystring
  • price_method_codeinteger

Other

  • codestring
  • bedroomsinteger
  • bathroomsinteger
  • carparksinteger
  • listed_atstring
  • is_new_listingboolean
  • is_new_homeboolean
  • is_coming_soonboolean
  • open_homesobject[]
  • officeobject
  • detail_availableboolean

Playground

Run this API

cURLshell
curl "https://api.perceptlayer.com/v1/oneroof/search?type=sale&region_id=35&bedrooms[]=3&bedrooms[]=4&sort=latest" \
  -H "X-API-Key: $API_KEY"

OneRoof · 5 endpoints

Endpoints

Every endpoint takes the same key. Open one for its parameters and an example request.

EndpointRequired parametersCost
GET/v1/oneroof/agency
id
1 credit
GET/v1/oneroof/agent
id
1 credit
GET/v1/oneroof/autocomplete
q+1 optional
1 credit
GET/v1/oneroof/listing
id
1 credit
GET/v1/oneroof/search
type+19 optional
1 credit

Overview

What you can get

The OneRoof API returns OneRoof property data as JSON through 5 endpoints.

  • Search: search takes a type (sale, rent or sold), with region_id, district_id, suburb_id, bedrooms[] (repeatable), bathrooms, carparks, category (1 to 9), price_min, price_max, land_area_min, land_area_max, floor_area_min, floor_area_max, office_id, agent_id, new_homes, sort (featured, latest, price_desc, price_asc or open_home), page and per_page.
  • Listings: listing takes an id.
  • Agents and agencies: agent and agency take an id.
  • Autocomplete: autocomplete takes a q, with type (sale, rent or sold).

The recorded search for three- and four-bedroom homes for sale in region 35 (Auckland), sorted by latest, returns items with id, uid, url, slug, code, title, listing_type, listing_type_label, property_type, category_id, price_text, currency, bedrooms, bathrooms, carparks, address, listed_at, is_new_listing, is_new_home, is_coming_soon, images, open_homes, agents and office. It also returns pagination with per_page, total_items (10,298), total_pages and next_page.

How a call works

Search a region: GET /v1/oneroof/search?type=sale&region_id=35&bedrooms[]=3&bedrooms[]=4&sort=latest with your key in the X-API-Key header. Each item's id is what listing takes, and each of its agents carries the id that agent takes. The address block holds region_id, district_id and suburb_id, the same names search filters on. Every successful call costs 1 credit; failed calls cost nothing.

Real estateJSONRESTMCP

More real estate APIs

28Hse4zida59199.co99acresAdondevivirApartment ListApartments.comAqarAqarmapArgenpropathome

Use cases

Track new listings in Auckland or another region, sorted by `latest`

Use the OneRoof API to track new listings in Auckland or another region, sorted by `latest`

Pull recently sold homes with `type=sold` for comparables

Use the OneRoof API to pull recently sold homes with `type=sold` for comparables

Plan open home visits from `open_homes`, or sort by `open_home`

Use the OneRoof API to plan open home visits from `open_homes`, or sort by `open_home`

Follow an agent's or office's listings with `agent_id` or `office_id`

Use the OneRoof API to follow an agent's or office's listings with `agent_id` or `office_id`

FAQ

Questions

Do I need a OneRoof account?

No. You call this OneRoof API with your Perceptlayer key in the `X-API-Key` header, with no OneRoof login.

How much does the OneRoof API cost?

Each successful call costs one credit. New accounts get free credits to start, and credit packs bring the price down as you scale.

What format are responses in?

Every endpoint returns JSON, with no HTML parsing on your side.

How do I filter by several bedroom counts?

Repeat `bedrooms[]`, as in `bedrooms[]=3&bedrooms[]=4`.

Should I build an OneRoof scraper instead?

You can, but an OneRoof scraper is code you maintain: page changes break it, requests get blocked, and OneRoof's terms govern how you collect data. The OneRoof API gives you 5 endpoints of named JSON fields for 1 credit per successful call, and failed calls cost nothing. A scraper makes sense only for data these endpoints don't return, so check the response in the playground on this page first.

Try the OneRoof API with 100 free credits

No credit card. Failed calls are never billed.

Get a free API keyRead the docs