# realestate.co.nz Property Search API Documentation Search New Zealand residential property for sale or rent on realestate.co.nz. Filter by region, district, suburb, price, bedrooms, bathrooms, car parks, land and floor area, property type, keyword, open homes, new builds, pool and more. Sort the results and page through them with page and rows. Each listing returns id, url, price text and a price number when the text is one clear amount, address with coordinates, bedrooms, bathrooms, parking, land and floor area, open homes, features, description, photos, agents and office. The site returns at most 10000 results per search, so narrow the search by location or price to go deeper. Use the locations endpoint or autocomplete to find location ids. A valid search with no hits returns an empty listings list and is a successful, billable response. - **Documentation:** [https://scrappa.co/docs/realestate-co-nz-api/realestate_co_nz_search](https://scrappa.co/docs/realestate-co-nz-api/realestate_co_nz_search) - **API group:** realestate.co.nz API - **Endpoint:** `GET https://scrappa.co/api/realestate-co-nz/search` ## Authentication Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key. ## Parameters | Parameter | Type | Required | Description | | --- | --- | --- | --- | | `type` | string | Yes | sale or rent. | | `page` | integer | No | Page number, 1-based. Defaults to 1. A search returns at most 10000 results, so page times rows must stay at or below 10000. | | `rows` | integer | No | Listings per page, 1 to 100. Defaults to 20. | | `region` | string | No | Region ids from the locations endpoint, separated by commas, e.g. 35 for Auckland. | | `district` | string | No | District ids from the locations endpoint, separated by commas, e.g. 225. | | `suburb` | string | No | Suburb ids from the locations endpoint or autocomplete, separated by commas, e.g. 3236. | | `include_nearby_suburbs` | boolean | No | Set to true to include listings from suburbs next to the chosen suburbs. | | `price_min` | integer | No | Minimum price in NZD. For rent this is NZD per week. | | `price_max` | integer | No | Maximum price in NZD. For rent this is NZD per week. | | `bedrooms_min` | integer | No | Minimum number of bedrooms. | | `bedrooms_max` | integer | No | Maximum number of bedrooms. | | `bathrooms_min` | integer | No | Minimum number of bathrooms. | | `bathrooms_max` | integer | No | Maximum number of bathrooms. | | `carparks` | integer | No | Minimum number of car parks. | | `land_area_min` | integer | No | Minimum land area in square metres. | | `land_area_max` | integer | No | Maximum land area in square metres. | | `floor_area_min` | integer | No | Minimum floor area in square metres. | | `floor_area_max` | integer | No | Maximum floor area in square metres. | | `property_type` | string | No | One or more types separated by commas. Sale: house, apartment, studio, townhouse, section, carpark. Rent: house, apartment, studio, townhouse, unit, carpark. | | `keyword` | string | No | Free-text keyword, up to 100 characters, e.g. pool. | | `open_home` | boolean | No | Set to true to return only listings with an upcoming open home. | | `new_construction` | boolean | No | Set to true to return only new builds. | | `mortgagee_sale` | boolean | No | Set to true to return only mortgagee sales. | | `swimming_pool` | boolean | No | Set to true to return only listings with a swimming pool. | | `coastal_waterfront` | boolean | No | Set to true to return only coastal waterfront listings. | | `pets_allowed` | boolean | No | Rent only. Set to true to return only rentals that allow pets. | | `floor_plans` | boolean | No | Set to true to return only listings with floor plans. | | `videos` | boolean | No | Set to true to return only listings with a video. | | `agent` | string | No | Agent ids separated by commas. Returns that agent's listings. | | `office` | string | No | Office ids separated by commas. Returns that office's listings. | | `school` | string | No | School ids from autocomplete (type school, field value), separated by commas. | | `sort` | string | No | best-match, featured, latest, oldest, lowest-price, highest-price, lowest-land-area or highest-land-area. Defaults to the site order. | ## Example request ```bash #!/bin/bash curl -X GET \ -H "x-api-key: YOUR_API_KEY_HERE" \ "https://scrappa.co/api/realestate-co-nz/search?type=sale®ion=35&bedrooms_min=3&sort=latest&rows=2" ``` ## Example response ```json { "success": true, "data": { "total_count": 11779, "page": 1, "page_size": 2, "has_more": true, "max_results_per_query": 10000, "search_location": { "regions": [ "Auckland" ] }, "listings": [ { "id": 43156911, "listing_no": "1973289", "url": "https://www.realestate.co.nz/43156911/residential/sale/67-lough-bourne-drive-pukekohe", "title": "Where design meets tranquillity", "status": "active", "category": "res_sale", "property_type": "House", "price_text": "Auction", "currency": "NZD", "price_code": 5, "auction_at": "2026-11-24T02:00:00Z", "auction_location": "8 Massey Avenue, Pukekohe", "address": { "full": "67 Lough Bourne Drive, Pukekohe, Franklin, Auckland", "display": "67 Lough Bourne Drive, Pukekohe", "street_number": "67", "street": "Lough Bourne Drive", "suburb": "Pukekohe", "district": "Franklin", "region": "Auckland", "postcode": "2120", "suburb_slug": "auckland_franklin_pukekohe_pukekohe", "district_slug": "auckland_franklin", "region_slug": "auckland", "latitude": -37.1880619, "longitude": 174.8975293 }, "bedrooms": 4, "bathrooms": 2, "parking": { "garage": 3, "carport": 0, "off_street": 0 }, "land_area": 1024, "land_area_unit": "sqm", "land_area_sqm": 1024, "floor_area": 237, "floor_area_unit": "sqm", "floor_area_sqm": 237, "published_at": "2026-10-25T02:57:04Z", "created_at": "2026-10-25T02:57:04Z", "open_homes": [ { "start": "2026-10-31T00:15:00Z", "end": "2026-10-31T00:45:00Z" }, { "start": "2026-11-01T00:15:00Z", "end": "2026-11-01T00:45:00Z" } ], "is_new_construction": false, "is_mortgagee_sale": false, "is_coastal_waterfront": false, "has_swimming_pool": false, "is_featured": true, "features": [], "description": "Positioned in a peaceful cul-de-sac and backing directly onto a tranquil bush setting, this striking Jennian-built residence offers a level of design distinctio\u2026", "photo_count": 24, "photos": [ { "url": "https://mediaserver.realestate.co.nz/listings/43156911/a876efeb05261acef191a50300b13ddd.jpg", "thumbnail_url": "https://mediaserver.realestate.co.nz/listings/43156911/a876efeb05261acef191a50300b13ddd.crop.31x40.jpg", "medium_url": "https://mediaserver.realestate.co.nz/listings/43156911/a876efeb05261acef191a50300b13ddd.crop.105x134.jpg", "large_url": "https://mediaserver.realestate.co.nz/listings/43156911/a876efeb05261acef191a50300b13ddd.crop.140x178.jpg" }, { "url": "https://mediaserver.realestate.co.nz/listings/43156911/a53dd85cc85c47ee7a6d723eb391452b.jpg", "thumbnail_url": "https://mediaserver.realestate.co.nz/listings/43156911/a53dd85cc85c47ee7a6d723eb391452b.crop.31x40.jpg", "medium_url": "https://mediaserver.realestate.co.nz/listings/43156911/a53dd85cc85c47ee7a6d723eb391452b.crop.105x134.jpg", "large_url": "https://mediaserver.realestate.co.nz/listings/43156911/a53dd85cc85c47ee7a6d723eb391452b.crop.140x178.jpg" } ], "agents": [ { "id": 564606, "name": "Mike Murphy", "first_name": "Mike", "last_name": "Murphy", "slug": "mike-murphy", "phone": "021 000 000", "email": "agent@example.co.nz", "website_url": "https://www.bayleys.co.nz/mike-murphy", "image": { "url": "https://mediaserver.realestate.co.nz/per_orgs/564606/4d7c20ec2f11518976580b049896b4da.jpg" }, "office_name": "Bayleys Real Estate Ltd (Licensed: REAA 2008) - Pukekohe", "listing_count": 26 }, { "id": 945281, "name": "Patrick Murphy", "first_name": "Patrick", "last_name": "Murphy", "slug": "patrick-murphy", "phone": "021 000 000", "email": "agent@example.co.nz", "website_url": "https://www.bayleys.co.nz/patrick-murphy", "image": { "url": "https://mediaserver.realestate.co.nz/per_orgs/945281/c4478c9aec106daf8f7dfd60e64550f8.jpg" }, "office_name": "Bayleys Real Estate Ltd (Licensed: REAA 2008) - Pukekohe", "listing_count": 14 } ], "office": { "id": 231240, "name": "Bayleys Real Estate Ltd (Licensed: REAA 2008) - Pukekohe", "colloquial_name": "Bayleys - Pukekohe", "slug": "bayleys-real-estate-ltd-licensed-reaa-2008-pukekohe", "phone": "021 000 000", "email": "agent@example.co.nz", "logo_url": "https://mediaserver.realestate.co.nz/per_orgs/231240/317fb1fad9daaf5bd0f93986120e4ebe.jpg", "brand_colour": "#00263A" } }, { "id": 43156900, "listing_no": "RMU46266", "url": "https://www.realestate.co.nz/43156900/residential/sale/62-barrack-road-mount-wellington", "title": "1950s Charm, Built to Last, Brilliant Location", "status": "active", "category": "res_sale", "property_type": "House", "price_text": "Deadline Sale", "currency": "NZD", "price_code": 7, "address": { "full": "62 Barrack Road, Mount Wellington, Auckland City, Auckland", "display": "62 Barrack Road, Mount Wellington", "street_number": "62", "street": "Barrack Road", "suburb": "Mount Wellington", "district": "Auckland City", "region": "Auckland", "postcode": "1051", "suburb_slug": "auckland_auckland-city_mount-wellington_mount-wellington", "district_slug": "auckland_auckland-city", "region_slug": "auckland", "latitude": -36.9000084, "longitude": 174.8390455 }, "bedrooms": 4, "bathrooms": 2, "parking": { "garage": 1, "carport": 0, "off_street": 1 }, "published_at": "2026-10-25T00:38:21Z", "created_at": "2026-10-25T00:38:21Z", "open_homes": [ { "start": "2026-10-28T04:00:00Z", "end": "2026-10-28T04:30:00Z" }, { "start": "2026-10-30T22:00:00Z", "end": "2026-10-30T22:30:00Z" } ], "is_new_construction": false, "is_mortgagee_sale": false, "is_coastal_waterfront": false, "has_swimming_pool": true, "is_featured": false, "features": [], "description": "Full of charm and offering plenty of space for family living, this appealing 1950s stucco home is one to put on your must-view list. With four double bedrooms, \u2026", "photo_count": 14, "photos": [ { "url": "https://mediaserver.realestate.co.nz/listings/43156900/2eb5a662426529e2b663cbadf97456a8.jpg", "thumbnail_url": "https://mediaserver.realestate.co.nz/listings/43156900/2eb5a662426529e2b663cbadf97456a8.crop.31x40.jpg", "medium_url": "https://mediaserver.realestate.co.nz/listings/43156900/2eb5a662426529e2b663cbadf97456a8.crop.105x134.jpg", "large_url": "https://mediaserver.realestate.co.nz/listings/43156900/2eb5a662426529e2b663cbadf97456a8.crop.140x178.jpg" }, { "url": "https://mediaserver.realestate.co.nz/listings/43156900/293ad86d346d45c896ffd0473c96d489.jpg", "thumbnail_url": "https://mediaserver.realestate.co.nz/listings/43156900/293ad86d346d45c896ffd0473c96d489.crop.31x40.jpg", "medium_url": "https://mediaserver.realestate.co.nz/listings/43156900/293ad86d346d45c896ffd0473c96d489.crop.105x134.jpg", "large_url": "https://mediaserver.realestate.co.nz/listings/43156900/293ad86d346d45c896ffd0473c96d489.crop.140x178.jpg" } ], "agents": [ { "id": 767852, "name": "Marama Curness", "first_name": "Marama", "last_name": "Curness", "slug": "marama-curness", "phone": "021 000 000", "email": "agent@example.co.nz", "image": { "url": "https://mediaserver.realestate.co.nz/per_orgs/767852/2a3cf8a36bd4b7855b5887900057dcd8.jpg" }, "office_name": "Megan Jaffe Real Estate Ltd (Licensed: REAA 2008) - Ray White, Remuera", "listing_count": 2 }, { "id": 29337, "name": "Glenn Curness", "first_name": "Glenn", "last_name": "Curness", "slug": "glenn-curness", "phone": "021 000 000", "email": "agent@example.co.nz", "website_url": "https://rwremuera.co.nz/team/agents/glenn-curness/", "image": { "url": "https://mediaserver.realestate.co.nz/per_orgs/29337/93fdadbe95f7c969ab0dbc05bc8f515a.jpg" }, "office_name": "Megan Jaffe Real Estate Ltd (Licensed: REAA 2008) - Ray White, Remuera", "listing_count": 2 } ], "office": { "id": 22063, "name": "Megan Jaffe Real Estate Ltd (Licensed: REAA 2008) - Ray White, Remuera", "colloquial_name": "Ray White - Remuera", "slug": "megan-jaffe-real-estate-ltd-licensed-reaa-2008-ray-white-remuera", "phone": "021 000 000", "email": "agent@example.co.nz", "logo_url": "https://mediaserver.realestate.co.nz/per_orgs/22063/bcf30b21eb0a703a94ac421a4a4520e4.jpg", "brand_colour": "#FFE512" } } ] }, "meta": { "endpoint_family": "search", "billable": true } } ``` ## Errors | Status | Error | Description | | --- | --- | --- | | | Error | page times rows is above 10000. Narrow the search. Not billed. | | | Error | The listing, agent or office does not exist. Not billed. | | | Error | realestate.co.nz could not be reached. Not billed. | | | Error | realestate.co.nz refused the request. Not billed. | | | Error | The upstream service is temporarily unavailable. Please retry shortly. | | | Error | realestate.co.nz returned an unexpected payload shape. Not billed. | | | Error | realestate.co.nz rejected the request parameters. Not billed. | ## More Scrappa resources - [API documentation](https://scrappa.co/docs) - [Full LLM-readable API reference](https://scrappa.co/llms-full.txt) - [OpenAPI specification](https://scrappa.co/docs/api.json) - [Pricing](https://scrappa.co/pricing)