OneRoof Search API returns up to 50 listings per page (40 by default) for sale, rent or sold in New Zealand. Filter by region, district and suburb, bedrooms, bathrooms, carparks, category, price, land and floor area, agency, agent and new homes, and sort by latest, price or open home. Each item carries the price text and, when the site shows one clear amount, a numeric price; text prices such as Auction stay text and price is null. Every item satisfies the filters you sent; items that break a filter are never returned and are counted in excluded_by_filters. pagination.total_items is the total the site reports for the same filters (null for sold and for agent searches). A page past the last returns an empty list with the page you asked for. Failed requests are not billed.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
19 optional filters available.
string
Required
Required. sale, rent or sold. A sold item is a past sale; its detail is not available.
example
integer
Optional
Region id from the autocomplete route (level region). Example: 35 for Auckland.
1234567890
integer
Optional
District id from the autocomplete route (level district).
1234567890
integer
Optional
Suburb id from the autocomplete route (level suburb).
1234567890
string
Optional
Bedroom counts, 0 to 5, as a comma list, for example 3,4. The value 5 means five or more bedrooms.
example
integer
Optional
Bathroom count, 0 to 5. 5 means five or more.
10
integer
Optional
Carpark count, 0 to 5. 5 means five or more.
10
integer
Optional
1 House, 2 Apartment, 3 Studio, 4 Townhouse, 5 Unit, 6 Home and Income, 7 Lifestyle Property, 8 Lifestyle Section, 9 Section.
10
number
Optional
Minimum price in NZD. For rent the price is per week. Listings priced in words only, such as Auction or By Negotiation, cannot be checked against a price range and are kept with price null.
10
number
Optional
Maximum price in NZD (per week for rent). Same rule as the minimum price.
10
number
Optional
Minimum land area in square metres. Listings without a land area are kept.
10
number
Optional
Maximum land area in square metres.
10
number
Optional
Minimum floor area in square metres. Listings without a floor area are kept.
10
number
Optional
Maximum floor area in square metres.
10
integer
Optional
Only listings of this agency (office id from a search item or the agency route).
1234567890
integer
Optional
Only listings of this agent. Needs office_id. The site cannot filter by agent, so the agent is matched inside the pages of that agency: a page can hold fewer than per_page items and total_items is null.
1234567890
boolean
Optional
true to return new home projects only.
true
string
Optional
featured (default), latest, price_desc, price_asc or open_home (earliest open home).
relevance
integer
Optional
Page number, 1-based. A page past the last returns an empty list with the page you asked for.
1
integer
Optional
Items per page, 1 to 50. Default 40.
10
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"items": [
{
"id": 2540878,
"uid": "rN6Ox",
"url": "https://www.oneroof.co.nz/property/auckland/onehunga/66-trafalgar-street/rN6Ox",
"code": "1755731",
"slug": "auckland/onehunga/66-trafalgar-street/rN6Ox",
"sold": null,
"tags": [],
"price": null,
"title": "Lucky 66 - THAB - corner site - well serviced",
"agents": [
{
"id": 117482,
"name": "Chester Duffett",
"phone": "021 000 0000",
"photo": "https://s.oneroof.co.nz/image/6d/fe/6dfecbb6f02e24a52d84ab4f2b4977a3.jpg?x-oss-process=image/quality,q_80"
}
],
"images": [
"https://s.oneroof.co.nz/image/81/5c/815ccc8bf3a5210632a7305b56bf7121.jpg?x-oss-process=image/quality,q_80",
"https://s.oneroof.co.nz/image/d7/01/d701083a1752e19de25adcbc9fcd3c09.jpg?x-oss-process=image/quality,q_80"
],
"office": {
"id": 107,
"name": "Bayleys Real Estate Ltd (Licensed: REAA 2008) - Bayleys, Remuera",
"photo": "https://s.oneroof.co.nz/image/3b/29/3b291efc7b46be09a66f4c4058daf534.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"
},
"status": 1,
"address": {
"full": "66 Trafalgar Street, Onehunga, Auckland City, Auckland",
"region": "Auckland",
"street": "66 Trafalgar Street",
"suburb": "Onehunga",
"district": "Auckland City",
"latitude": -36.916478,
"longitude": 174.7748438,
"region_id": 35,
"suburb_id": 2899,
"district_id": 225
},
"auction": {
"at": "2026-11-24T21:00:00Z",
"end": null,
"address": null
},
"summary": null,
"bedrooms": 7,
"carparks": 0,
"currency": "NZD",
"bathrooms": 4,
"listed_at": "2026-10-25T16:00:00Z",
"price_max": null,
"price_min": null,
"video_url": null,
"open_homes": [],
"price_note": "25 Nov 2026 10:00",
"price_text": "Auction",
"category_id": 1,
"floor_plans": [],
"is_new_home": false,
"property_id": null,
"tour_3d_url": null,
"building_age": "1910",
"image_groups": [
{
"key": "living room",
"label": "Living Room",
"images": [
"https://s.oneroof.co.nz/image/42/54/4254139bfbad8f712e008e21db064ec4.jpg?x-oss-process=image/quality,q_80",
"https://s.oneroof.co.nz/image/f4/e3/f4e35606c5860357ca7f5a8ab6060c54.jpg?x-oss-process=image/quality,q_80"
]
},
{
"key": "kitchen",
"label": "Kitchen",
"images": [
"https://s.oneroof.co.nz/image/42/54/4254139bfbad8f712e008e21db064ec4.jpg?x-oss-process=image/quality,q_80",
"https://s.oneroof.co.nz/image/f2/25/f225f72b6769da0172da34ff71a02d0a.jpg?x-oss-process=image/quality,q_80"
]
}
],
"listing_type": "sale",
"price_period": null,
"land_area_sqm": 797,
"property_type": "House",
"available_from": null,
"floor_area_sqm": null,
"is_coming_soon": false,
"is_new_listing": true,
"land_area_text": "797m\u00b2",
"rateable_value": "$2,220,000",
"estimated_value": null,
"floor_area_text": null,
"online_auctions": null,
"detail_available": true,
"median_sale_price": null,
"price_method_code": 3,
"listing_type_label": "Residential for sale"
}
],
"pagination": {
"page": 1,
"per_page": 40,
"next_page": 2,
"total_items": 16791,
"total_pages": 420
},
"excluded_by_filters": 0
},
"meta": {
"billable": true,
"endpoint_family": "search"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A parameter is missing or invalid. This response is not billable.
{
"errors": {
"type": [
"The type field is required."
]
},
"message": "The request validation failed"
}Upstream Unavailable
OneRoof could not be reached. This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "search"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "OneRoof could not be reached. Please retry shortly."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.