openapi: 3.1.0
info:
version: ''
title: Properties API
description: "<div class=\"cta\" style=\"display: flex; justify-content: flex-start; flex-wrap: wrap;\
\ margin-top: 0px; margin-bottom: 30px\">\n <div\n style=\"\n text-align: left;\n \
\ min-width: 1000px;\n font-family: 'Open Sans', Arial, sans-serif;\n padding: 13px\
\ 20px;\n color: rgb(255, 255, 255);\n font-size: 16px;\n line-height: 28px;\n\
\ font-weight: 700;\n border-radius: 4px;\n background: #0078BD;\n text-decoration:\
\ none;\n margin-right: 20px;\n margin-top: 10px;\n \"\n ><i class=\"fa-solid\
\ fa-house\"></i> Properties API</div\n >\n\n- **[Properties/Summary](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-2-property-summary):\
\ <span style=\"color:#28a745;\">**GET**</span> /api/v2/properties/{propertyId}/summary**</br>Retrieves\
\ basic property and listing information about a property, including a single photo and current market\
\ status </br>\n- **[Properties/Attributes](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-attributes):\
\ <span style=\"color:#28a745;\">**GET**</span> /api/v2/properties/{propertyId}/attributes**</br>Retrieves\
\ comprehensive and up to date property attributes and features for a given property </br>\n- **[Properties/Listings](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-listings):\
\ <span style=\"color:#28a745;\">**GET**</span> /api/v2/properties/{propertyId}/listings**</br>Retrieves\
\ current and historic listings for a given property.</br>\n- **[Properties/Planning:](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-planning)\
\ <span style=\"color:#28a745;\">**GET**</span> /api/v2/properties/{propertyId}/planning**</br>Retrieves\
\ planning and zoning information for a given property</br>\n- **[Properties/TenureType:](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-tenure-type)\
\ <span style=\"color:#28a745;\">**GET**</span> /api/v2/properties/{propertyId}/tenure-type**</br>Retrieves\
\ historical property tenure information for a given property</br>\n- **[Properties/Transactions:](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-transactions)\
\ <span style=\"color:#28a745;\">**GET**</span> /api/v2/properties/{propertyId}/transactions**</br>Retrieves\
\ sold transactions for a given property</br>\n\n<div class=\"cta\" style=\"display: flex; justify-content:\
\ flex-start; flex-wrap: wrap; margin-top: 0px; margin-bottom: 30px\">\n <div\n style=\"\n \
\ text-align: left;\n min-width: 1000px;\n font-family: 'Open Sans', Arial, sans-serif;\n\
\ padding: 13px 20px;\n color: rgb(255, 255, 255);\n font-size: 16px;\n \
\ line-height: 28px;\n font-weight: 700;\n border-radius: 4px;\n background:\
\ #0078BD;\n text-decoration: none;\n margin-right: 20px;\n margin-top: 10px;\n\
\ \"\n ><i class=\"fa-solid fa-money-bill-wave\"></i> AVM Valuation API</div\n\
\ >\n\n \n- **[Properties/Valuations/Sale](https://developer.proptrack.com.au/docs/apis/properties/operations/create-a-api-v-1-property-valuation-sale):\
\ <span style=\"color:#28a745;\">**Post**</span> /api/v1/properties/valuations/sale**</br> Orders\
\ a sale valuation from PropTrack's Automated Valuation Model (AVM) for a given address string, either\
\ as requestType=enquiry OR requestType=origination</br>\n- **[Properties/Valuations/Sale](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-sale-request-type-enquiry-or-request-type-origination):\
\ <span style=\"color:#28a745;\">**GET**</span> /api/v1/properties/{propertyId}/valuations/sale**</br>\
\ Orders a sale valuation from PropTrack's Automated Valuation Model (AVM) for a given property (by\
\ propertyId), , either as ?requestType=enquiry OR ?requestType=origination</br>\n- **[Properties/Valuations/Rent](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-rent-request-type-enquiry-or-request-type-origination):\
\ <span style=\"color:#28a745;\">**GET**</span> /api/v1/properties/{propertyId}/valuations/rent?requestType=enquiry\
\ OR requestType-origination**</br> Orders an Enquiry Rental valuation from PropTrack's Automated\
\ Valuation Model (AVM) for a given property (by propertyId), either as Enquiry or Origination Request\
\ Type</br>\n- **[Properties/Valuations/Sale~AVM Plus](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-sale-request-type-plus):\
\ <span style=\"color:#28a745;\">**Post**</span> /api/v1/properties/valuations/sale ~plus**</br> Orders\
\ a AVM Plus valuation from PropTrack's Automated Valuation Model (AVM) for a given address string,\
\ combines Sale and Rental into a single request</br>\n- **[Properties/Valuations/Sale~AVM Plus](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-sale-request-type-plus):\
\ <span style=\"color:#28a745;\">**GET**</span> /api/v1/properties/{propertyId}/valuations/sale?requestType=plus**</br>\
\ Orders a AVM Plus valuation from PropTrack's Automated Valuation Model (AVM) for a given property\
\ (by propertyId), combines Sale and Rental into a single request</br>\n- **[Properties/Valuations/Sale~AVM\
\ Pro](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-sale-request-type-pro):\
\ <span style=\"color:#28a745;\">**Post**</span> /api/v1/properties/valuations/sale ~pro**</br> Orders\
\ a AVM Pro valuation from PropTrack's Automated Valuation Model (AVM) for a given address string,\
\ combines Sale, Rental and environment hazards into a single request</br>\n- **[Properties/Valuations/Sale~AVM\
\ Pro](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-sale-request-type-pro):\
\ <span style=\"color:#28a745;\">**GET**</span> /api/v1/properties/{propertyId}/valuations/sale?requestType=pro**</br>\
\ Orders a AVM Pro valuation from PropTrack's Automated Valuation Model (AVM) for a given property\
\ (by propertyId), combines Sale, Rental and environment hazards into a single request</br>\n\n\n\n\
</br>\n\n<div class=\"section-about\" style=\"margin-top: 40px\">\n <div class=\"page-section__inner\"\
\ style=\"margin: 0px auto; max-width: 1250px; -webkit-font-smoothing: antialiased\" >\n <div\n\
\ class=\"cards-list\"\n style=\"\n display: flex;\n flex-wrap: wrap;\n \
\ justify-content: space-between;\n margin: 20px 0px;\n max-width: 900px;\n \
\ padding: px;\n box-sizing: 1px;\n border-box: 1px;\n border-color: black;\n\
\ \"\n >\n <div\n class=\"cards-list__item\"\n style=\"\n margin-top:\
\ 16px;\n padding: 0px 16px;\n max-width: 250px;\n min-width: 200px;\n\
\ margin-bottom: 0px;\n box-sizing: border-box;\n \"\n >\n <div\n\
\ class=\"card__thumb\"\n style=\"height: 49px; width: 50px; background-color: #0078BD;\
\ border-radius: 4px; padding: 4px; display: flex; align-items: center; justify-content: center;\"\
\n >\n <i class=\"fa-regular fa-badge-check\" style=\"font-size: 24px; color: #F7F8F9;\"\
></i>\n </div>\n <div\n class=\"card__title\"\n style=\"\n \
\ margin-top: 22px;\n font-family: Graphik, Arial, sans-serif;\n font-size:\
\ 24px;\n line-height: 36px;\n font-weight: 700;\n color: rgb(44,\
\ 44, 44);\n \"\n >\n Getting Started\n </div>\n <div\n \
\ class=\"card__text\"\n style=\"\n margin-top: 8px;\n font-size:\
\ 14px;\n line-height: 24px;\n font-family: 'Open Sans', Arial, sans-serif;\n\
\ font-weight: 400;\n color: rgb(44, 44, 44);\n \"\n >\n \
\ Start your journey\n </div>\n <ul>\n <li>\n <a href=\"\
https://developer.proptrack.com.au/docs/apis/api-trials\"\n > API Trials</a\n \
\ >\n </li>\n <li><a href=\"https://developer.proptrack.com.au/docs/apis/how-to-authenticate\"\
>Authentication</a></li>\n <li>\n <a href=\"https://developer.proptrack.com.au/docs/apis/error-handling\"\
>Error Handling</b></a>\n </li>\n </ul>\n </div>\n <div\n class=\"\
cards-list__item\"\n style=\"\n margin-top: 16px;\n padding: 0px 16px;\n\
\ max-width: 250px;\n min-width: 200px;\n margin-bottom: 0px;\n \
\ box-sizing: border-box;\n \"\n >\n <div\n class=\"card__thumb\"\n\
\ style=\"height: 49px; width: 50px; background-color: #0078BD; border-radius: 4px; padding:\
\ 4px; display: flex; align-items: center; justify-content: center;\"\n >\n <i class=\"\
fa-regular fa-list\" style=\"font-size: 24px; color: #F7F8F9;\"></i>\n </div>\n <div\n\
\ class=\"card__title\"\n style=\"\n margin-top: 22px;\n font-family:\
\ Graphik, Arial, sans-serif;\n font-size: 24px;\n line-height: 36px;\n \
\ font-weight: 700;\n color: rgb(44, 44, 44);\n \"\n >\n \
\ API References\n </div>\n <div\n class=\"card__text\"\n style=\"\
\n margin-top: 8px;\n font-size: 14px;\n line-height: 24px;\n \
\ font-family: 'Open Sans', Arial, sans-serif;\n font-weight: 400;\n \
\ color: rgb(44, 44, 44);\n \"\n >\n Explore our knowledge base\n \
\ </div>\n <ul>\n <li>\n <a href=\"https://developer.proptrack.com.au/docs/apis/guide\"\
\n >API Guide</a\n >\n </li>\n <li><a href=\"https://developer.proptrack.com.au/docs/apis/rate-limits\"\
>Rate Limiting</a></li>\n <li>\n <a href=\"https://developer.proptrack.com.au/docs/apis/getting-support\"\
\n >Getting Support</a\n >\n </li>\n </ul>\n </div>\n\
\ <div\n class=\"cards-list__item\"\n style=\"\n margin-top: 16px;\n \
\ padding: 0px 16px;\n max-width: 250px;\n min-width: 200px;\n \
\ margin-bottom: 0px;\n box-sizing: border-box;\n \"\n >\n <div\n \
\ class=\"card__thumb\"\n style=\"height: 49px; width: 50px; background-color: #0078BD;\
\ border-radius: 4px; padding: 4px; display: flex; align-items: center; justify-content: center;\"\
\n >\n <i class=\"fa-regular fa-files\" style=\"font-size: 24px; color: #F7F8F9;\"\
></i>\n </div>\n <div\n class=\"card__title\"\n style=\"\n \
\ margin-top: 22px;\n font-family: Graphik, Arial, sans-serif;\n font-size:\
\ 24px;\n line-height: 36px;\n font-weight: 700;\n color: rgb(44,\
\ 44, 44);\n \"\n >\n Useful Docs\n </div>\n <div\n \
\ class=\"card__text\"\n style=\"\n margin-top: 8px;\n font-size:\
\ 14px;\n line-height: 24px;\n font-family: 'Open Sans', Arial, sans-serif;\n\
\ font-weight: 400;\n color: rgb(44, 44, 44);\n \"\n >\n \
\ Helpful resources\n </div>\n <ul>\n <li>\n <a href=\"https://developer.proptrack.com.au/docs/apis/pagination\"\
>Pagination</a>\n </li>\n <li><a href=\"https://developer.proptrack.com.au/docs/apis/rules-engine\"\
>Rules Engine</a></li>\n <li><a href=\"https://developer.proptrack.com.au/docs/apis/faqs\"\
>FAQs</a></li>\n </ul>\n </div>\n <div\n class=\"cards-list__item\"\n \
\ style=\"\n margin-top: 16px;\n padding: 0px 16px;\n max-width: 250px;\n\
\ min-width: 200px;\n margin-bottom: 0px;\n box-sizing: border-box;\n \
\ \"\n >\n <div\n class=\"card__thumb\"\n style=\"height: 49px;\
\ width: 50px; background-color: #0078BD; border-radius: 4px; padding: 4px; display: flex; align-items:\
\ center; justify-content: center;\"\n >\n <i class=\"fa-regular fa-tag\" style=\"\
font-size: 24px; color: #F7F8F9;\"></i></i>\n </div>\n <div\n class=\"card__title\"\
\n style=\"\n margin-top: 22px;\n font-family: Graphik, Arial, sans-serif;\n\
\ font-size: 24px;\n line-height: 36px;\n font-weight: 700;\n \
\ color: rgb(44, 44, 44);\n \"\n >\n Get in Touch\n </div>\n\
\ <div\n class=\"card__text\"\n style=\"\n margin-top: 8px;\n\
\ font-size: 14px;\n line-height: 24px;\n font-family: 'Open Sans',\
\ Arial, sans-serif;\n font-weight: 400;\n color: rgb(44, 44, 44);\n \
\ \"\n >\n Connect with us\n </div>\n <ul>\n <li><a href=\"\
https://www.proptrack.com.au/contact-us/sales/\">Contact Sales</a></li>\n <li><a href=\"\
https://www.proptrack.com.au/support/contact-support/\">Contact Support</a></li>\n </ul>\n\
\ </div>\n </div>\n </div>\n</div>"
contact:
email: support@proptrack.com
name: PropTrack Support
servers:
- url: https://data.proptrack.com
description: ''
paths:
/api/v2/properties/{propertyId}/summary:
parameters:
- schema:
type: integer
example: 123456789
name: propertyId
in: path
required: true
description: Unique identifier for a property</br> Refer to [Obtaining a propertyId](https://developer.proptrack.com.au/docs/apis/guide#obtaining-a-propertyid)
get:
summary: /api/v2/properties/{propertyId}/summary
tags:
- Summary
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
propertyId:
type: integer
x-stoplight:
id: q7xkn5piafan2
example: 8282053
description: Unique identifier for a property
address:
type:
- object
- 'null'
description: Property Address
properties:
fullAddress:
type: string
x-stoplight:
id: 5zcjnr5bylbwx
example: 12 Bowman Cl, Araluen, NT 0870
description: Full address of the property
unitNumber:
type:
- string
- 'null'
x-stoplight:
id: 9con9e51ism0o
description: Unit number of the property
streetNumber:
type: string
x-stoplight:
id: clbko5io646v2
example: '12'
description: Street number of the property
streetName:
type: string
x-stoplight:
id: bw4tvscj30lip
example: BOWMAN
description: Street name of the property
streetType:
type: string
x-stoplight:
id: 5hlu0340u8gpp
example: CL
description: Street type of the property
suburb:
type: string
x-stoplight:
id: y963qnnh405jj
example: ARALUEN
description: Suburb of the property
postcode:
type: string
x-stoplight:
id: uq3cgq7x70fo4
example: 0870
description: Postcode of the property
state:
type: string
x-stoplight:
id: flar8wdlxumz6
example: NT
description: State of the proeprty
location:
type: object
x-stoplight:
id: 132d2f6rincwh
description: Geographical location of the property
properties:
latitude:
type:
- number
- 'null'
x-stoplight:
id: f8wfuuk7n91yk
example: -34.05438
format: float
description: Latitude of the property
longitude:
type:
- number
- 'null'
x-stoplight:
id: zaalil8hrli8m
example: 151.6941
format: float
description: Longitude of the property
attributes:
x-stoplight:
id: vjprtbbmqi2np
type:
- object
- 'null'
description: Basic property attributes
properties:
bedrooms:
type:
- object
- 'null'
x-stoplight:
id: a9zi5xc7xzkq4
properties:
value:
type: integer
x-stoplight:
id: 7j4k9ktnp6k1p
example: 3
description: Number of bedrooms
sourceDate:
type: string
x-stoplight:
id: muwf0padjmu3h
example: '2022-12-10'
description: Date that the source provided the data for this record.
format: date
bathrooms:
type:
- object
- 'null'
x-stoplight:
id: xevadvjoh94ay
properties:
value:
type: integer
x-stoplight:
id: swxxo7b3t5mb5
example: 2
description: Number of bathrooms
sourceDate:
type: string
x-stoplight:
id: 1ugflicke9iyp
example: '2022-12-10'
format: date
description: Date that the source provided the data for this record.
carSpaces:
type:
- object
- 'null'
x-stoplight:
id: xsjmdm722qhd5
properties:
value:
type: integer
x-stoplight:
id: 3li5c1kkva2wp
example: 1
description: Number of car spaces
sourceDate:
type: string
x-stoplight:
id: wembyvpemf5o7
example: '2022-12-10'
format: date
description: Date that the source provided the data for this record.
livingArea:
type:
- object
- 'null'
x-stoplight:
id: 15pp9fi95kye2
properties:
value:
type: integer
x-stoplight:
id: ocuiz9j6z7027
example: 212
description: Living area (measured in m2)
sourceDate:
type: string
x-stoplight:
id: q3y3d06efheqo
example: '2022-12-10'
format: date
description: Date that the source provided the data for this record.
landArea:
type:
- object
- 'null'
x-stoplight:
id: gthtn8avs8wa3
properties:
value:
type: integer
x-stoplight:
id: m30y4qhfnj76b
example: 851
description: Land space area (measured in m2)
sourceDate:
type: string
x-stoplight:
id: xqqywt8o9wvwv
example: '2022-12-10'
format: date
description: Date that the source provided the data for this record.
propertyType:
type:
- object
- 'null'
x-stoplight:
id: z0t66hhmpp8wz
properties:
value:
x-stoplight:
id: grgym9ry9c8r6
example: house
enum:
- house
- unit
description: Classification of the type of property
sourceDate:
type: string
x-stoplight:
id: z8gu3rlabpvwj
example: '2022-12-10'
format: date
description: Date that the source provided the data for this record.
recentSale:
x-stoplight:
id: bzgjd39mjrswl
type:
- object
- 'null'
description: Provides recent (within the past 6 months) sale information for a given
`propertyId`<br>If no sale has occurred in the past 6 months, this will return null
required:
- transactionDate
properties:
transactionDate:
type: string
x-stoplight:
id: nx1tp23jizhhl
example: '2023-01-25'
description: "Date associated with the transaction event<br>\r\nFormat `YYYY-MM-DD`"
format: date
sourceCategory:
x-stoplight:
id: h9kp1j8pjeow5
enum:
- vg
- agency
- other
example: agency
description: Source of transaction event data
saleValue:
type:
- integer
- 'null'
x-stoplight:
id: u84r5p1m5l7ce
example: 1350000
description: "Price associated with the transaction event <br>\r\nNote: suppressed\
\ transaction prices will be returned as undefined"
saleValueSuppressed:
type: boolean
x-stoplight:
id: lbyc1qn1xqquq
description: Flags if the saleValue has been suppressed
listingId:
type:
- string
- 'null'
x-stoplight:
id: b7ph3gbozq8ui
description: Unique identifier for a listing
example: '7654321'
image:
x-stoplight:
id: r13ft7o6ua5w1
type:
- object
- 'null'
description: Provides a single property image for use in property summary experiences.<br>Refer
to [Constructing an Image URL](https://developer.proptrack.com.au/docs/apis/faqs#how-do-i-construct-an-image-url)
for details on how to use this image object.
properties:
id:
type:
- string
- 'null'
x-stoplight:
id: m42v0vlg3d598
example: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
description: The identifier associated with the image
extension:
x-stoplight:
id: nh7hr644wuhdy
enum:
- jpg
- gif
- png
- pcx
- svg
- webp
- ppm
- tiff
- nb
example: jpg
description: File extension type
type:
x-stoplight:
id: fzuov6qm2la6r
enum:
- image
- floorplan
example: image
description: Image type
sha:
type:
- string
- 'null'
x-stoplight:
id: ijzdeupkgpgb6
example: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
description: Secure hashing algorithm
activeListings:
type: array
x-stoplight:
id: iy5usz8oixn50
description: "Provides an array of active rent or sale listings<br>\r\nIf the property\
\ has no active listings an empty array is returned"
items:
x-stoplight:
id: g4y5gi13rs9ug
type: object
properties:
listingId:
type: string
x-stoplight:
id: z06m8u4iy713w
description: Unique identifier for a listing
example: '7654321'
priceDescription:
type: string
x-stoplight:
id: vsrr1i7q7tcux
description: "Price displayed on the listing<br>\r\nNote: This value may not\
\ always describe the price, but a description such as \"Price on request\""
listingType:
x-stoplight:
id: zxq2nm9ehbw57
enum:
- sale
- rent
example: sale
description: Refer to [Listing Types](https://developer.proptrack.com.au/docs/apis/guide#listing-type)
marketStatus:
x-stoplight:
id: koi63swv45oo7
example:
- recentlySold
type: array
description: "Providex the market status for the property<br>\r\nNote that a property\
\ may have multiple active listings, as well as a recent sale, resulting in an accumulation\
\ of statuses. These will be sorted alphabetically in the response."
items:
x-stoplight:
id: pfcz17ab6v8ac
enum:
- offMarket
- forSale
- forRent
- recentlySold
example: recentlySold
parcels:
type: array
x-stoplight:
id: 24rsyk8dpera2
items:
x-stoplight:
id: 63vj2frykduvj
type: object
properties:
planNumber:
type:
- string
- 'null'
x-stoplight:
id: 6e2ymedhn84zu
example: '786836'
description: The number of a subdivision of an original parcel of land into
separate titles
lotNumber:
type:
- string
- 'null'
x-stoplight:
id: tq7r5qvr3a6e7
example: '124'
description: The lot number of the property
examples:
Recently Sold - no active listing, agency advised price:
value:
propertyId: 3987592
address:
fullAddress: 21 STANLEY ST RICHMOND VIC 3121
unitNumber: null
streetNumber: '21'
streetName: STANLEY
streetType: ST
suburb: RICHMOND
state: VIC
postcode: '3121'
location:
latitude: -37.82364584
# --- truncated at 32 KB (577 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rea-group/refs/heads/main/openapi/rea-group-properties-openapi.yml