OneRoof Listing API returns one sale or rental listing by its numeric id: price text and numbers, bond and rates, rooms, land and floor area, address with coordinates, description (text and HTML), features, photos with room labels, floor plans, open homes, valuation and public records, history, nearby sales, zoned schools, crime level, suburb statistics, agents and agency. Sold items from the search route have no detail. An unknown or ended listing answers 404. Failed requests are not billed.
Run this endpoint
OneRoof Listing API Documentation
1 credit/request
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.
id
integer
Required
Required. The numeric listing id (id) from a search item or the listing_id of an autocomplete property. Sold items have no detail.
Example value
1234567890
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"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": [],
"crime": {
"level": 1,
"categories": [
{
"key": "theft",
"label": "Theft",
"incidents": [
{
"at": "2018-01-31T11:00:00Z",
"activity": "Theft (Except Motor Vehicles), NEC",
"category": "Theft"
}
]
}
]
},
"icons": [],
"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"
},
"rental": {
"bond": "2-3 weeks' rental fee",
"yield": "0",
"rental": null,
"median_rent": null
},
"status": 1,
"suburb": {
"id": 2899,
"url": null,
"name": "Onehunga",
"slug": "onehunga-auckland-city-2899",
"label": "Onehunga, Auckland City",
"region": "Auckland",
"district": "Auckland City",
"description": "Onehunga is a suburb which lies within the Territorial Authority of Auckland, one of 269 residential suburbs which form the wider region. Onehunga is the 17th largest suburb of Auckland in terms of th",
"market_info": null,
"median_rent": null,
"demographics": null,
"median_sale_price": null,
"rental_yield_percent": null,
"capital_growth_percent": null
},
"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
},
"company": null,
"history": [
{
"at": "2026-09-30T11:00:00Z",
"note": "Property listed",
"type": "list",
"label": "Listed for sale",
"value": null
},
{
"at": "2024-04-30T12:00:00Z",
"note": "RV reassessment",
"type": "cv",
"label": "RV reassessment: $2,220,000",
"value": "$2,220,000"
}
],
"schools": {
"zoned": [
{
"id": 149,
"name": "Royal Oak Intermediate School",
"type": "State",
"level": "Intermediate",
"phone": "09 636 5667",
"score": 2,
"years": "Year 7-8",
"gender": "Gender: Co-Educational",
"address": "74 Symonds Street, Royal Oak, Auckland",
"website": "http://www.royaloakint.school.nz/",
"latitude": -36.915792,
"longitude": 174.774516
}
],
"out_zoned": [
{
"id": 233,
"name": "Royal Oak School",
"type": "State",
"level": "Contributing",
"phone": "09 624 2800",
"score": 8,
"years": "Year 1-6",
"gender": "Gender: Co-Educational",
"address": "Chandler Avenue, Royal Oak, Auckland",
"website": "http://www.rops.school.nz",
"latitude": -36.908656,
"longitude": 174.774377
}
],
"none_zoned": [
{
"id": 5142,
"name": "Kiwi Supertots Learning Centre Royal Oak",
"type": "Privately owned",
"level": "Education and Care Service",
"phone": "09 625 0050",
"score": 0,
"years": null,
"gender": "Gender: ",
"address": "15 Mt Smart Road, Royal Oak, Auckland",
"website": "",
"latitude": -36.912423,
"longitude": 174.777204
}
],
"early_childhood": []
},
"summary": null,
"bedrooms": 7,
"carparks": 0,
"currency": "NZD",
"features": [],
"material": null,
"property": {
"id": 155505,
"slug": "auckland/onehunga/66-trafalgar-street/rN6Ox",
"latitude": -36.916545,
"longitude": 174.774748,
"street_id": 32220
},
"bathrooms": 4,
"hold_type": null,
"info_pack": null,
"listed_at": "2026-10-25T16:00:00Z",
"price_max": null,
"price_min": null,
"valuation": {
"land_tax": "$10,057",
"land_value": null,
"annual_rates": null,
"capital_value": null,
"public_records": {
"facts": [
{
"label": "On OneRoof",
"value": "0 days"
},
{
"label": "Floor Area",
"value": "186m\u00b2"
}
],
"valued_at": "2024-04-30T12:00:00Z",
"land_value": "$2,125,000",
"rateable_value": "$2,220,000",
"improvement_value": "$95,000",
"land_value_change_percent": -14,
"rateable_value_change_percent": -12,
"improvement_value_change_percent": 26
},
"rateable_value": null,
"estimated_value": null,
"rateable_value_at": null
},
"video_url": null,
"disclaimer": "Our estimated property valuations are based on the most up-to-date data available from local councils and othe",
"home_plans": [],
"open_homes": [],
"price_note": "25 Nov 2026 10:00",
"price_text": "Auction",
"updated_at": "2026-10-25T20:40:34Z",
"view_count": 0,
"year_built": null,
"category_id": 1,
"description": "As luck would have it, the perfect combination for a site might just exist.\r\rA prominent corner position of prime Terrace Housing and Apartment Building (THAB) zoned land, dual vehicle crossings and public services conveniently located along both street frontages. It's a compelling combination with plenty to offer.\r\rFor those looking to hold, four existing rental flats provide a healthy rental income, currently returning $116,220 p.a, with an estimated appraised rental of $124,020 p.a - representing a potential gross yield of approximately 5.6% based on the current CV of $2,220,000.\r\rDevelop now, hold and develop later, or simply enjoy the rental return. The choice is yours.\r\rCall Chester to arrange a viewing and for a comprehensive range of property documents and reports to aid your due diligence.\r\rThe lucky 66 Trafalgar Street may just be your smooth road to success.\r\rDisclaimer: Underground service locations and accessibility are indicative only. Prospective purchasers should undertake their own due diligence and seek independent professional advice. Rental appraisals are estimates only, and gross yield calculations are based on the current CV and exclude outgoings.",
"floor_plans": [],
"is_new_home": false,
"property_id": 155505,
"tour_3d_url": null,
"building_age": null,
"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",
"nearby_sales": [
{
"id": 6463245,
"url": "https://www.oneroof.co.nz/property/auckland/onehunga/57a-trafalgar-street/1O6Px",
"street": "57A Trafalgar Street",
"suburb": "Onehunga",
"sold_at": "2026-10-06T11:00:00Z",
"bedrooms": 5,
"carparks": 1,
"bathrooms": 3,
"price_text": "$1,163,000",
"land_area_sqm": 180,
"floor_area_sqm": 169
}
],
"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": null,
"estimated_value": null,
"floor_area_text": null,
"online_auctions": null,
"sold_previously": null,
"description_html": "<p>As luck would have it, the perfect combination for a site might just exist.\r</p><p>\r</p><p>A prominent corner position of prime Terrace Housing and Apartment Building (THAB) zoned land, dual vehicle crossings and public services conveniently located along both street frontages. It's a compelling combination with plenty to offer.\r</p><p>\r</p><p>For those looking to hold, four existing rental flats provide a healthy rental income, currently returning $116,220 p.a, with an estimated appraised rental of $124,020 p.a - representing a potential gross yield of approximately 5.6% based on the current CV of $2,220,000.\r</p><p>\r</p><p>Develop now, hold and develop later, or simply enjoy the rental return. The choice is yours.\r</p><p>\r</p><p>Call Chester to arrange a viewing and for a comprehensive range of property documents and reports to aid your due diligence.\r</p><p>\r</p><p>The lucky 66 Trafalgar Street may just be your smooth road to success.\r</p><p>\r</p><p>Disclaimer: Underground service locations and accessibility are indicative only. Prospective purchasers should undertake their own due diligence and seek independent professional advice. Rental appraisals are estimates only, and gross yield calculations are based on the current CV and exclude outgoings.\r</p>",
"detail_available": true,
"legal_description": null,
"median_sale_price": 1634173.7224,
"price_method_code": 3,
"listing_type_label": "Residential for sale",
"accommodation_types": []
},
"meta": {
"billable": true,
"endpoint_family": "listing"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
422
Validation Error
A parameter is missing or invalid. This response is not billable.
{
"errors": {
"id": [
"The id field is required."
]
},
"message": "The request validation failed"
}
404
Not Found
The listing does not exist or has ended. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "listing"
},
"error": {
"code": "NOT_FOUND",
"message": "The requested record was not found."
},
"success": false
}
503
Upstream Unavailable
OneRoof could not be reached. This response is not billable and is retryable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "listing"
},
"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.