openapi: 3.1.0 info: version: '' title: Properties API description: "

\n Properties API\n\n- **[Properties/Summary](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-2-property-summary):\ \ **GET** /api/v2/properties/{propertyId}/summary**
Retrieves\ \ basic property and listing information about a property, including a single photo and current market\ \ status
\n- **[Properties/Attributes](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-attributes):\ \ **GET** /api/v2/properties/{propertyId}/attributes**
Retrieves\ \ comprehensive and up to date property attributes and features for a given property
\n- **[Properties/Listings](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-listings):\ \ **GET** /api/v2/properties/{propertyId}/listings**
Retrieves\ \ current and historic listings for a given property.
\n- **[Properties/Planning:](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-planning)\ \ **GET** /api/v2/properties/{propertyId}/planning**
Retrieves\ \ planning and zoning information for a given property
\n- **[Properties/TenureType:](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-tenure-type)\ \ **GET** /api/v2/properties/{propertyId}/tenure-type**
Retrieves\ \ historical property tenure information for a given property
\n- **[Properties/Transactions:](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-transactions)\ \ **GET** /api/v2/properties/{propertyId}/transactions**
Retrieves\ \ sold transactions for a given property
\n\n

\n AVM Valuation API\n\n \n- **[Properties/Valuations/Sale](https://developer.proptrack.com.au/docs/apis/properties/operations/create-a-api-v-1-property-valuation-sale):\ \ **Post** /api/v1/properties/valuations/sale**
Orders\ \ a sale valuation from PropTrack's Automated Valuation Model (AVM) for a given address string, either\ \ as requestType=enquiry OR requestType=origination
\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):\ \ **GET** /api/v1/properties/{propertyId}/valuations/sale**
\ \ Orders a sale valuation from PropTrack's Automated Valuation Model (AVM) for a given property (by\ \ propertyId), , either as ?requestType=enquiry OR ?requestType=origination
\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):\ \ **GET** /api/v1/properties/{propertyId}/valuations/rent?requestType=enquiry\ \ OR requestType-origination**
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
\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):\ \ **Post** /api/v1/properties/valuations/sale ~plus**
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
\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):\ \ **GET** /api/v1/properties/{propertyId}/valuations/sale?requestType=plus**
\ \ 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
\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):\ \ **Post** /api/v1/properties/valuations/sale ~pro**
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
\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):\ \ **GET** /api/v1/properties/{propertyId}/valuations/sale?requestType=pro**
\ \ 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
\n\n\n\n\
\n\n

\n \n \n \n \n

\n \n Getting Started\n

\n \n \ \ Start your journey\n

\n API Trials\n

Authentication
\n Error Handling\n

\n \n \n \n \n \n \ \ API References\n \n \n Explore our knowledge base\n \ \ \n

\n API Guide\n

Rate Limiting
\n Getting Support\n

\n \n\ \ \n \n \n \n \n Useful Docs\n \n \n \ \ Helpful resources\n \n

\n \n \n \n \n \n \n Get in Touch\n \n\ \ \n Connect with us\n \n

Contact Sales
Contact Support

\n\ \ \n \n \n" 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
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`
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
\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
\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.
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
\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
\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
\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 longitude: 144.99504193 parcels: - planNumber: '786836' lotNumber: '124' attributes: bedrooms: value: 3 sourceDate: '2024-11-06' bathrooms: value: 1 sourceDate: '2024-11-06' carSpaces: value: 4 sourceDate: '2024-11-06' livingArea: null landArea: value: 420 sourceDate: '2024-11-06' propertyType: value: house sourceDate: '2024-11-06' recentSale: transactionDate: '2024-11-28' sourceCategory: agency saleValueSuppressed: true listingId: '146535076' image: id: e7f71870fef11b2dcec2e1b65f6bae2287aa84058a9ddbc8673378dc9856bf23.jpg extension: jpg type: image sha: e7f71870fef11b2dcec2e1b65f6bae2287aa84058a9ddbc8673378dc9856bf23 activeListings: [] marketStatus: - recentlySold Mulitple Active Listings: value: propertyId: 8282053 marketStatus: - forSale - forRent address: fullAddress: 12 Bowman Cl, Araluen, NT 0870 unitNumber: string streetNumber: '12' streetName: BOWMAN streetType: CL suburb: ARALUEN postcode: 0870 state: NT location: latitude: -23.705948 longitude: 133.85501 parcels: - planNumber: '786836' lotNumber: '124' attributes: bedrooms: value: 3 sourceDate: '2022-12-10' bathrooms: value: 2 sourceDate: '2022-12-10' carSpaces: value: 1 sourceDate: '2022-12-10' livingArea: value: 212 sourceDate: '2022-12-10' landArea: value: 851 sourceDate: '2022-12-10' propertyType: value: house sourceDate: '2022-12-10' image: id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg extension: jpg type: image sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 recentSale: null activeListings: - listingId: '12345' priceDescription: Contact Agent listingType: sale - listingId: '23456' priceDescription: 400 per week listingType: rent Recently Sold plus active listing: value: propertyId: 3910648 address: fullAddress: 12 ROSEVILLE AVE DONCASTER VIC 3108 unitNumber: null streetNumber: '12' streetName: ROSEVILLE streetType: AVE suburb: DONCASTER state: VIC postcode: '3108' location: latitude: -37.78227685 longitude: 145.12890991 parcels: - planNumber: '786836' lotNumber: '124' attributes: bedrooms: value: 4 sourceDate: '2024-11-29' bathrooms: value: 2 sourceDate: '2024-11-29' carSpaces: value: 2 sourceDate: '2024-11-29' livingArea: value: 199 sourceDate: '2005-01-24' landArea: value: 726 sourceDate: '2024-09-25' propertyType: value: house sourceDate: '2024-10-02' recentSale: transactionDate: '2024-10-02' saleValue: 1675000 sourceCategory: agency saleValueSuppressed: false listingId: '146136344' image: id: c4ea87c700118204d9c5ec4a51d92ddd08b23ece764ddd6e16817c3d5806bcb0.jpg extension: jpg type: image sha: c4ea87c700118204d9c5ec4a51d92ddd08b23ece764ddd6e16817c3d5806bcb0 activeListings: - listingId: '440615860' priceDescription: $950 per week listingType: rent marketStatus: - forRent - recentlySold Recently Sold no active listing, VG Advised: value: propertyId: 2986307 address: fullAddress: 9 BELLEVUE ST RICHMOND VIC 3121 unitNumber: null streetNumber: '9' streetName: BELLEVUE streetType: ST suburb: RICHMOND state: VIC postcode: '3121' location: latitude: -37.82402263 longitude: 145.01295994 parcels: - planNumber: '786836' lotNumber: '124' attributes: bedrooms: value: 2 sourceDate: '2024-07-31' bathrooms: value: 1 sourceDate: '2024-07-11' carSpaces: value: 0 sourceDate: '2006-02-25' livingArea: null landArea: value: 165 sourceDate: '2024-07-31' propertyType: value: house sourceDate: '2024-07-31' recentSale: transactionDate: '2024-07-31' saleValue: 1450000 sourceCategory: vg saleValueSuppressed: false listingId: '145475828' image: id: 4cc41c4ba0c4d67d4c28688aa55db47f8bd33f349862c91a2b136b88102171b0.jpg extension: jpg type: image sha: 4cc41c4ba0c4d67d4c28688aa55db47f8bd33f349862c91a2b136b88102171b0 activeListings: [] marketStatus: - recentlySold no recent sale, active sale listing: value: propertyId: 11182936 address: fullAddress: UNIT 417 163 FITZROY ST ST KILDA VIC 3182 unitNumber: UNIT 417 streetNumber: '163' streetName: FITZROY streetType: ST suburb: ST KILDA state: VIC postcode: '3182' location: latitude: -37.85867069 longitude: 144.97974113 parcels: - planNumber: '786836' lotNumber: '124' attributes: bedrooms: value: 1 sourceDate: '2024-11-27' bathrooms: value: 1 sourceDate: '2024-11-27' carSpaces: value: 1 sourceDate: '2021-07-27' livingArea: null landArea: value: 2226 sourceDate: '2024-03-14' propertyType: value: unit sourceDate: '2023-05-08' recentSale: null image: id: fc4954c024a3ea45a0182f04a2d9a8804554f02d181440a20a20aeea82f291a4.jpg extension: jpg type: image sha: fc4954c024a3ea45a0182f04a2d9a8804554f02d181440a20a20aeea82f291a4 activeListings: - listingId: '146731236' priceDescription: $350,000 - $370,000 listingType: sale marketStatus: - forSale Off Market, no recent sale: value: propertyId: 19925089 address: fullAddress: UNIT 1 688 TOORAK RD MALVERN VIC 3144 unitNumber: UNIT 1 streetNumber: '688' streetName: TOORAK streetType: RD suburb: MALVERN state: VIC postcode: '3144' location: latitude: -37.84414868 longitude: 145.03309673 parcels: - planNumber: '786836' lotNumber: '124' attributes: bedrooms: value: 3 sourceDate: '2024-03-18' bathrooms: value: 2 sourceDate: '2024-03-18' carSpaces: value: 2 sourceDate: '2024-03-18' livingArea: null landArea: value: 654 sourceDate: '2024-03-14' propertyType: value: unit sourceDate: '2024-05-09' recentSale: null image: id: 204ba7728fcfa253ae35040a3e0d1464fe8d8484f7f16f338e974f31343505d4.jpg extension: jpg type: image sha: 204ba7728fcfa253ae35040a3e0d1464fe8d8484f7f16f338e974f31343505d4 activeListings: [] marketStatus: - offMarket headers: Content-Type: schema: enum: - application/json type: string description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '400': description: ' > #### Bad Request (400)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: jvlh1l5egfq94 items: x-stoplight: id: zmygarky4e42l type: object properties: code: x-stoplight: id: lr8uy5txv886e enum: - 7004 - 7008 - 7011 description: Defines the type of error that has occurred description: type: string x-stoplight: id: w2tcvh3qoapl3 description: Overview of the error that has occurred example: An incorrect field type has been entered - Please ensure that all values are using the correct field type parameters: type: object x-stoplight: description: A set of parameters that are causing the error and the rule that was invoked id: n6bfzihyqvtzp properties: propertyId: type: string x-stoplight: id: ghwrv21xo8w2n example: must be an integer required: - code - description '401': description: ' > #### Unauthorized (401)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: 9jgvy94upt2pg items: x-stoplight: id: yshulszncgxj7 type: object properties: code: x-stoplight: id: wo2j9tfr0b14t enum: - 9012 - 9016 description: Defines the type of error that has occurred level: x-stoplight: id: p4a9uyp3uqnmz x-deprecated: true enum: - CRITICAL description: type: string x-stoplight: id: ofdd0n63lrzfc description: Overview of the error that has occurred example: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again required: - code - description '403': description: ' > #### Forbidden (403)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: 2n4094xyv7c3x items: x-stoplight: id: ww63urgscamyz type: object properties: code: x-stoplight: id: if53bdzhg3dhe enum: - 9003 description: Defines the type of error that has occurred description: type: string x-stoplight: id: xgep3hs2wejns description: Overview of the error that has occurred example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - code - description '404': description: ' > #### Not Found (404)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: ek0iij804q29a items: x-stoplight: id: hwjd034zagomj type: object properties: code: x-stoplight: id: hvpv418x25dsg enum: - 7002 description: Defines the type of error that has occurred description: type: string x-stoplight: id: b6pietkvvz1yl description: Overview of the error that has occurred parameters: type: object x-stoplight: id: jc2xvv6i7pzy4 description: A set of parameters that are causing the error and the rule that was invoked properties: propertyId: type: string x-stoplight: id: izl1136mxldzs example: cannot be found required: - code - description '429': description: ' > #### Too Many Requests (429)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: a2hawxu516voh items: x-stoplight: id: ukclsu2ln096k type: object properties: code: x-stoplight: id: kb5dmftdhjo8x enum: - 9011 description: Defines the type of error that has occurred level: x-stoplight: id: x3huiwrf7ut5b x-deprecated: true enum: - CRITICAL description: type: string x-stoplight: id: bwaho3k6i7dl6 description: Overview of the error that has occurred example: Rate limit has been exceeded - Please try again shortly required: - code - description '500': description: ' > #### Internal Server Error (500)' operationId: get-v2-summary x-stoplight: id: us3fqq14p5fzq parameters: - schema: type: string example: Bearer xxxxx in: header name: Authorization description: Provide your bearer token as a string, in the format Bearer {access_token} in the Authorization Header Refer to Authentication required: true description: "This service retrieves a summary view of the provided `propertyId`.
\r\n

The\ \ summary contains a single photo, the current market status, key attributes, any recent sale\ \ transaction details, and current listing activity.

\r\n\r\n#### Data Attribution Notice:\r\ \nThis endpoint contains State and Territory data which may be subject to approval by the relevant\ \ government department.\r\nDue to licensing agreement requirements, it is necessary to include\ \ data disclaimers and PropTrack branding when displaying this data in a user experience or printable\ \ output.\r\n

\r\nDisclaimer Types: `vg`,`geoscape`,`serviceAgent`\r\n\r\nPlease refer\ \ to [Disclaimers and Branding](https://developer.proptrack.com.au/docs/apis/disclaimersBranding)\ \ for more information on implementing data source disclaimers in your experience.\r\n" /api/v2/properties/{propertyId}/attributes: parameters: - schema: type: integer example: 123456789 name: propertyId in: path required: true description: Unique identifier for a property
Refer to [Obtaining a propertyId](https://developer.proptrack.com.au/docs/apis/guide#obtaining-a-propertyid) get: summary: /api/v2/properties/{propertyId}/attributes tags: - Attributes responses: '200': description: ' > #### Success (200)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object required: - propertyId properties: propertyId: type: integer x-stoplight: id: x1wcwhbyk4b65 description: Unique identifier for a property example: 123456789 attributes: type: object x-stoplight: id: ow5925e8cvnmu properties: bedrooms: type: - object - 'null' x-stoplight: id: n4083nk3hen2v properties: value: type: integer x-stoplight: id: clhrjw7nexbaf description: Number of bedrooms example: 4 sourceDate: type: string x-stoplight: id: wejzs033oc0m2 format: date description: Date that the source provided the data for this record.
Format `YYYY-MM-DD` example: '2023-01-25' bathrooms: type: - object - 'null' x-stoplight: id: wheyondlgmyqr properties: value: type: integer x-stoplight: id: t1e1gd1v0eud7 description: Number of bathrooms example: 2 sourceDate: type: string x-stoplight: id: hz3drhii7fqyb format: date example: '2023-01-25' description: Date that the source provided the data for this record.
Format `YYYY-MM-DD` carSpaces: type: - object - 'null' x-stoplight: id: 47axpda4hallg properties: value: type: integer x-stoplight: id: dmtxr6c91rfen description: Number of car spaces example: 2 sourceDate: type: string x-stoplight: id: bdu1bh1o3lxyb description: Date that the source provided the data for this record.
Format `YYYY-MM-DD` format: date example: '2023-01-25' floorArea: type: - object - 'null' x-stoplight: id: oalb1kyuw9viz properties: value: type: integer x-stoplight: id: 0p66jx4bak7za description: Floor space area (measured in m2) example: 325 sourceDate: type: string x-stoplight: id: peqx778ewgee3 description: Date that the source provided the data for this record.
Format `YYYY-MM-DD` format: date example: '2023-01-25' landArea: type: - object - 'null' x-stoplight: id: kus2buhyhvx9y properties: value: type: integer x-stoplight: id: qbtzw4x45ba5j example: 650 description: Land space area (measured in m2) sourceDate: type: string x-stoplight: id: bfph5i6u113xk description: Date that the source provided the data for this record.
Format `YYYY-MM-DD` format: date example: '2023-01-25' landUse: type: - object - 'null' x-stoplight: id: f0tb8dh3rtfwb properties: classifications: x-stoplight: id: 3060qmcgtfe0p type: array description: Classifications of the type of land use items: x-stoplight: id: y2ed1p6g2zgoe type: object properties: value: x-stoplight: id: pfa8bsdz6esr5 enum: - residential - other livingArea: type: - object - 'null' x-stoplight: id: kdnq9wm1kq2cx properties: value: type: integer x-stoplight: id: nz318r1prsq4n description: Living area (measured in m2) sourceDate: type: string x-stoplight: id: 1cdaqk89tcm8t description: Date that the source provided the data for this record.
Format `YYYY-MM-DD` format: date example: '2023-01-25' propertyType: type: - object - 'null' x-stoplight: id: hew0cv4jllic0 properties: value: x-stoplight: id: 89uzsaiwdulwn enum: - unit - house description: Classification of the type of property sourceDate: type: string x-stoplight: id: 0y78bu068nrw0 format: date example: '2023-01-25' description: Date that the source provided the data for this record.
Format `YYYY-MM-DD` roofType: type: - object - 'null' x-stoplight: id: iigjecy70ekod properties: value: type: string x-stoplight: id: fvb5cjdvawgi4 description: The type of roof on the property example: colorbond sourceDate: type: string x-stoplight: id: zv44o02mq5fz6 description: Date that the source provided the data for this record.
Format `YYYY-MM-DD` format: date example: '2023-01-25' wallType: type: - object - 'null' x-stoplight: id: ro9rahe6kllol properties: value: type: string x-stoplight: id: gq03g8fmjvnr3 description: The type of material used on the external walls example: brick sourceDate: type: string x-stoplight: id: 8fgfjzs00g8x5 description: Date that the source provided the data for this record.
Format `YYYY-MM-DD` format: date example: '2023-01-25' yearBuilt: type: - object - 'null' x-stoplight: id: zp64yliv3q0a6 properties: value: type: integer x-stoplight: id: 5k9zns7m13mbp description: The year that the property was built example: 2019 sourceDate: type: string x-stoplight: id: edj91g0w1d7qt description: Date that the source provided the data for this record.
Format `YYYY-MM-DD` format: date example: '2023-01-25' features: type: array x-stoplight: id: 8ej3gbdi2mgca items: x-stoplight: id: 2isoyfs6x2f0d enum: - airConditioning - alarmSystem - balcony - builtInRobes - courtyard - deck - dishwasher - ductedCooling - ductedHeating - electricHeating - evaporativeCooling - floorboards - fullyFenced - furnished - gasHeating - greyWaterSystem - gym - hydronicHeating - insideSpa - openFireplace - outsideSpa - poolAbove - poolInGround - remoteGarage - reverseCycleAirCon - rumpusRoom - secureParking - shed - solarHotWater - solarPanels - splitSystemAirCon - splitSystemHeating - study - tennisCourt - vacuumSystem - waterTank - workshop '400': description: ' > #### Bad Request (400)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: v837ml7r05rxl items: x-stoplight: id: nx5khpow3oin2 type: object properties: code: x-stoplight: id: 94ts6ukimutn8 enum: - 7004 - 7008 - 7011 description: Defines the type of error that has occurred description: type: string x-stoplight: id: p8l3gcnqzefm8 description: Overview of the error that has occurred example: An incorrect field type has been entered - Please ensure that all values are using the correct field type parameters: type: object x-stoplight: id: 7o3jribipqu6z description: A set of parameters that are causing the error and the rule that was invoked properties: propertyId: type: string x-stoplight: id: eblvhfgcxohg1 example: must be an integer required: - code - description '401': description: ' > #### Unauthorized (401)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: e39h6kc7a1oy2 items: x-stoplight: id: 4iaqwxq9cf2he type: object properties: code: x-stoplight: id: c1lcuqokkx0i2 enum: - 9012 - 9016 description: Defines the type of error that has occurred level: x-stoplight: id: 7oeyte8vbd61j x-deprecated: true enum: - CRITICAL description: type: string x-stoplight: id: f5knmkvofp3xg description: Overview of the error that has occurred example: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again required: - code - description '403': description: ' > #### Forbidden (403)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: fvac9jrga0piy items: x-stoplight: id: ayjcicjfsjlu2 type: object properties: code: x-stoplight: id: tfp9frtmdyco5 enum: - 9003 description: Defines the type of error that has occurred description: type: string x-stoplight: id: i30fbmnpiklyj description: Overview of the error that has occurred example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - code - description '404': description: ' > #### Not Found (404)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: 8anir8d5za9r3 items: x-stoplight: id: jodxizyivkxv7 type: object properties: code: x-stoplight: id: 7756mpy6h0p23 enum: - 7002 description: Defines the type of error that has occurred description: type: string x-stoplight: id: psj6o0i0dnzqi description: Overview of the error that has occurred parameters: type: object x-stoplight: id: kr7k1nvv1uccd description: A set of parameters that are causing the error and the rule that was invoked properties: propertyId: type: string x-stoplight: id: l0qfz7o0anaf4 example: cannot be found required: - code - description '429': description: ' > #### Too Many Requests (429)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: 5zermde5wqnzt items: x-stoplight: id: 50b2j3m7ba9np type: object properties: code: x-stoplight: id: apai66khrgtzf enum: - 9011 description: Defines the type of error that has occurred level: x-stoplight: id: 0on9tfoci606j x-deprecated: true enum: - CRITICAL description: type: string x-stoplight: id: jcmniduhjxxli description: Overview of the error that has occurred example: Rate limit has been exceeded - Please try again shortly required: - code - description '500': description: ' > #### Internal Server Error (500)' operationId: properties-attributes x-stoplight: id: x3lmc3ikfjuye parameters: - schema: type: string example: Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO default: Bearer {access_token} in: header name: Authorization description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true description: "Retrieves comprehensive and up to date property attributes and features for a given\ \ property.\r\n\r\n\r\n#### Data Attribution Notice:\r\nThis endpoint contains State and Territory\ \ data which may be subject to approval by the relevant government department.\r\nDue to licensing\ \ agreement requirements, it is necessary to include data disclaimers and PropTrack branding when\ \ displaying this data in a user experience or printable output.\r\n

\r\nDisclaimer Types:\ \ `vg`,`geoscape`,`serviceAgent`\r\n\r\nPlease refer to [Disclaimers and Branding](https://developer.proptrack.com.au/docs/apis/disclaimersBranding)\ \ for more information on implementing data source disclaimers in your experience.\r\n" /api/v2/properties/{propertyId}/listings: get: tags: - Listings summary: /api/v2/properties/{propertyId}/listings description: Retrieves current and historic listings for a given property. operationId: listings parameters: - name: Authorization in: header description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true schema: type: string examples: - Bearer eyJraWQiOiJiYWRmNzUyNC1jYzBkLTQ3YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiOiJKV1QiLCJhbGc example: Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO default: Bearer {access_token} - name: latestListingOnly in: query description: 'Return the single most recent listing ' allowEmptyValue: true schema: type: boolean default: false examples: - true - name: numberOfResults in: query description: Limit the number of listings returned allowEmptyValue: true schema: type: integer maximum: 25 default: 25 examples: - 5 - name: listingType in: query description: Select the type of listings returned allowEmptyValue: true schema: enum: - sale - rent examples: - sale type: string - name: status in: query description: Choose the status of the listings returned
Refer to [Listing Statuses](https://developer.proptrack.com.au/docs/apis/guide#listing-status) allowEmptyValue: true schema: enum: - current - sold - notSold - leased - notLeased examples: - sold type: string - name: propertyId in: path description: Unique identifier for a property
Refer to [Obtaining a propertyId](https://developer.proptrack.com.au/docs/apis/guide#obtaining-a-propertyid) required: true schema: type: string responses: '200': description: ' > #### Success (200) ' content: application/json: schema: type: object x-examples: example-1: propertyId: '1234567' listings: - listingId: '7654321' listedAddress: addressIdentifier: LG/21-23 Seven Hill Road, Baulkham Hills, NSW 2153 country: AU latitude: -33.762436 longitude: 150.99017 postcode: '2153' state: NSW street: LG/21-23 Seven Hill Road streetName: Seven Hill Road streetNumber: 21-23 suburb: Baulkham Hills agency: agencyName: Hualei Properties - Sydney agent: agentName: Danny (Lei) Shi attributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 floorArea: 143 landArea: 615 propertyType: strata propertySubType: apartment yearBuilt: 1920 features: - builtInRobes - airConditioning auctionDate: '2021-10-18' auctionTime: 01:00:00 am daysToSale: 23 description: This stunning apartment is located in the heart of Baulkham Hills, with only few minutes walking distance to Stockland Shopping Centre, close to express buses to the City and Parramatta, and ONLY minutes away from local schools.

Other Features Include:
- 2 Spacious bedrooms with build in wardrobes, main with ensuite;
- Open plan kitchen with gas cooking, oven and dishwasher;
- Two tiny and bright bathrooms;
- Combined dinning and lounge area throughout to the balcony;
- With internal laundry and dryer;
- With security intercom, secured access and car space.

Please contact us for inspection. firstSeenDate: '2021-09-27' listingType: sale priceDescription: Offers over $1,000,000 listingPrice: 998000 status: sold saleDate: '2021-10-18' saleValue: 1030000 auctionResult: soldAtAuction source: REA videoUrl: https://www.youtube.com/embed/j4clLwXYYXA images: id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg extension: jpg type: image orderIndex: 0 date: '2018-09-27' sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 attachments: url: https://insights.proptrack.com/documents/5c4de68d682dfaa984d4470e1326707d88cb8a4ae667de309810a7aae8a7840f/statement_of_information1.pdf type: statement_of_information date: '2018-09-27' required: - listings properties: propertyId: type: string description: Unique identifier for a property examples: - '1234567' listings: type: array items: type: object properties: listingId: type: string description: Unique identifier for a listing examples: - '7654321' address: type: object x-stoplight: id: p2apob5mn0rv2 properties: fullAddress: type: string x-stoplight: id: 76a20oy1p3s9m description: Listed address, as provided by the selling agent example: 1/67 Louisa Rd, Birchgrove, NSW 2041 location: type: object x-stoplight: id: v35iq9k6ufysh properties: latitude: type: number x-stoplight: id: c5kkrs55knx3j format: float description: Listed latitude, as provided by the selling agent example: -34.05438 longitude: type: number x-stoplight: id: j9esc0tdqkjlr format: float description: Listed longitude, as provided by the selling agent example: 151.6941 attributes: type: object properties: bedrooms: type: integer description: Number of bedrooms examples: - 4 bathrooms: type: integer description: Number of bathrooms examples: - 3 carSpaces: type: integer description: Number of car spaces examples: - 3 floorArea: type: integer description: Floor space area (measured in m2) examples: - 143 landArea: type: integer description: Land space area (measured in m2) examples: - 615 propertyType: description: Type of property enum: - house - unit - land type: string propertySubType: enum: - apartment - retire - serviced_apartment - studio - unit - townhouse - alpine - flat - villa - terrace - house - warehouse - duplex_semi_detached - acreage - mixedfarming - lifestyle - horticulture - dairy - farmlet - residential_land - viticulture - livestock - cropping - rural_other - unitblock - residential_other description: Refer to [Property Sub-Types](https://developer.proptrack.com.au/docs/apis/guide#property-types--property-sub-types) type: string yearBuilt: type: integer description: The year that the property was built examples: - 1920 features: type: array description: Refer to [Features](https://developer.proptrack.com.au/docs/apis/guide#features) items: enum: - airConditioning - alarmSystem - balcony - broadband - builtInRobes - courtyard - deck - dishwasher - ductedCooling - ductedHeating - electricHeating - electricHotWater - evaporativeCooling - floorboards - fullyFenced - furnished - gasHeating - gasHotWater - greyWaterSystem - gym - heatPumpHotWater - hydronicHeating - insideSpa - intercom - multiDwelling - newConstruction - openFireplace - outdoorEnt - outsideSpa - payTV - petFriendly - poolAbove - poolInG - remoteGarage - reverseCycleAirCon - rumpusRoom - secureParking - shed - smokers - solarHotWater - solarPanels - spa - splitSystemAirCon - splitSystemHeating - study - tennisCourt - vacuumSystem - waterTank - workshop auctionDate: type: string description: Auction local start date based on the listing's location (only available when the listing type is sale)
Format `YYYY-MM-DD` format: date examples: - '2021-10-18' auctionTime: type: string description: Auction local start time based on the listing's location (only available when the listing type is sale) examples: - 01:00:00 am auctionResult: enum: - passedIn - passedInVendorBid - soldAfterAuction - soldAtAuction - soldPriorToAuction - withdrawn description: Auction outcome for sale listings
Refer to [Auction Results](https://developer.proptrack.com.au/docs/apis/guide#auction-results) type: string daysOnSite: type: integer description: Number of days the listing was advertised before it was delisted examples: - 23 description: type: string description: Verbiage displayed on a listing that describes the listed property examples: - This stunning apartment is located in the heart of Baulkham Hills firstSeenDate: type: string description: Date that the listing was published to realestate.com.au
Format `YYYY-MM-DD` format: date examples: - '2021-09-27' listingType: enum: - sale - rent description: Refer to [Listing Types](https://developer.proptrack.com.au/docs/apis/guide#listing-type) type: string priceDescription: type: string description: 'Price displayed on the listing
Note: This value may not always describe the price, but a description such as "Price on request"' examples: - Offers over $1,000,000 example: Offers from $1M listingPrice: type: integer description: 'Price that represents the advertised listing value. When the listing type is ''rent, then returned value is ''per week''.
**Note: This value is not permitted for display**' examples: - 998000 status: enum: - current - sold - notSold - leased - notLeased description: "Listing status. \n* When listing type is `sale`, then `status`\ \ can be `current`, `sold`, `notSold`\n* When listing type is `rent` then\ \ `status` can be `current`, `leased`, `notLeased`\nRefer to [Listing Statuses](https://developer.proptrack.com.au/docs/apis/guide#listing-status)" type: string saleDate: type: string description: Agent advised sale date
Format `YYYY-MM-DD` format: date examples: - '2021-10-18' saleValue: type: integer description: "Agent advised sale value
\r\nIf `\"saleValueSuppressed\":\ \ true`, then this field will return as `undefined`" examples: - 1030000 saleValueSuppressed: type: boolean description: Flags if the `saleValue` has been suppressed source: enum: - REA description: Where the listing data has been sourced from type: string videoUrl: type: string description: Link to video that was uploaded to the listing examples: - https://www.youtube.com/embed/j4clLwXYYXA images: type: array description: Refer to [Constructing an Image URL](https://developer.proptrack.com.au/docs/apis/faqs#how-do-i-construct-an-image-url) items: type: object properties: id: type: string description: The identifier associated with the image examples: - d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg extension: enum: - jpg - gif - png - pcx - svg - webp - ppm - tiff - bmp description: File extension type type: string type: enum: - image - agency_logo - floorplan description: Image type type: string orderIndex: type: integer description: The order in which images are displayed on a listing. I.e. orderIndex '0' for an 'image' type represents the cover image examples: - 0 date: type: string description: Date that the image was uploaded
Format `YYYY-MM-DD` format: date examples: - '2018-09-27' sha: type: string description: Secure hashing algorithm examples: - d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 attachments: type: array items: type: object properties: url: type: string description: Web address for attachment examples: - https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf type: enum: - statement_of_information description: Attachment type type: string date: type: string description: Date that the attachment was uploaded
Format `YYYY-MM-DD` format: date examples: - '2018-09-27' energyEfficiencyRating: type: - number - 'null' x-stoplight: id: ceh5dgsuippv8 example: 6 description: Energy Efficiency Rating for the listing. If no rating has been provided, this will be null default: null agents: type: - array - 'null' x-stoplight: id: yzxn0a8newdbo description: "Information regarding the agent(s) associated with a listing
\r\ \nAdditional authorisation is required for access\ \ to this data point. Please refer to your account manager for more information." items: x-stoplight: id: qfr7xx4ynm3cf type: object properties: name: type: string x-stoplight: id: 5iu9dw82c1f47 description: The full name of the agent linked to a listing example: Joe Bloggs agentId: type: string x-stoplight: id: duf05lx4kdaww description: "The ID of the agent linked to a listing.\r\nEach REA customer/account\ \ is assigned a unique 6 character identity code" example: '817222' agencies: type: - array - 'null' x-stoplight: id: ftdqnapqigs9c description: "Information regarding the agency(s) associated with a listing
\r\ \nAdditional authorisation is required for access\ \ to this data point. Please refer to your account manager for more information." items: x-stoplight: id: brhfwa7bxwtpa type: object properties: name: type: - string - 'null' x-stoplight: id: 9sler4qtrttuv description: The name of the agency linked to the listing example: Estate Agent Name agencyId: type: string x-stoplight: id: k0b5rb0th5rdr description: The ID of the agency linked to a listing. Each REA customer/account is assigned a unique 6 character identity code example: AXXYYY examples: Sale Listing Currently on the Market: value: propertyId: '1234567' listings: - listingId: '7654321' attributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 floorArea: 143 landArea: 615 propertyType: house propertySubType: house features: - builtInRobes - airConditioning auctionDate: '2022-06-24' auctionTime: 11:00:00 am description: This stunning apartment is located in the heart of Baulkham Hills firstSeenDate: '2022-06-21' listingType: sale priceDescription: Offers over $3,000,000 listingPrice: 2850000 status: current source: REA videoUrl: https://www.youtube.com/embed/j4clLwXYYXA images: - id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg extension: jpg type: image orderIndex: 0 date: '2022-06-21' sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 - id: 34868e32cef313f5e4a6aed0daef7ae19acc95d268cc112ca3dc39cbf91be5a3.jpg extension: jpg type: image orderIndex: 1 date: '2022-06-21' sha: 34868e32cef313f5e4a6aed0daef7ae19acc95d268cc112ca3dc39cbf91be5a3 - id: 14c0fb79c39d4230e6ccf89be69a2b1cc71754c307adeb4bf05a2dc4eeacdfdd.jpg extension: jpg type: image orderIndex: 2 date: '2022-06-21' sha: 14c0fb79c39d4230e6ccf89be69a2b1cc71754c307adeb4bf05a2dc4eeacdfdd attachments: - url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf type: statement_of_information date: '2022-06-21' energyEfficiencyRating: 2 Sold at Auction Listing: value: propertyId: '1234567' listings: - listingId: '7654321' attributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 floorArea: 143 landArea: 615 propertyType: unit propertySubType: apartment yearBuilt: 1920 features: - builtInRobes - airConditioning auctionDate: '2021-10-18' auctionTime: 11:00:00 am daysOnSite: 23 description: This stunning apartment is located in the heart of Baulkham Hills" firstSeenDate: '2021-09-27' listingType: sale priceDescription: Offers over $1,000,000 listingPrice: 998000 status: sold saleDate: '2021-10-18' saleValue: 1030000 saleValueSuppressed: false auctionResult: soldAtAuction source: REA videoUrl: https://www.youtube.com/embed/j4clLwXYYXA images: - id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg extension: jpg type: image orderIndex: 0 date: '2021-09-27' sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 - id: 34868e32cef313f5e4a6aed0daef7ae19acc95d268cc112ca3dc39cbf91be5a3.jpg extension: jpg type: image orderIndex: 1 date: '2021-09-27' sha: 34868e32cef313f5e4a6aed0daef7ae19acc95d268cc112ca3dc39cbf91be5a3 - id: 14c0fb79c39d4230e6ccf89be69a2b1cc71754c307adeb4bf05a2dc4eeacdfdd.jpg extension: jpg type: image orderIndex: 2 date: '2021-09-27' sha: 14c0fb79c39d4230e6ccf89be69a2b1cc71754c307adeb4bf05a2dc4eeacdfdd attachments: - url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf type: statement_of_information date: '2021-09-27' energyEfficiencyRating: 2 Leased Rental Listing: value: propertyId: '1234567' listings: - listingId: '7654321' attributes: bedrooms: 4 bathrooms: 3 carSpaces: 3 floorArea: 143 landArea: 615 propertyType: unit propertySubType: unit yearBuilt: 1920 features: - airConditioning - petFriendly description: This stunning apartment is located in the heart of Baulkham Hills firstSeenDate: '2022-05-01' listingType: rent priceDescription: Offers Between $485.00 & $525.00 per week7 listingPrice: 455 status: leased source: REA videoUrl: https://www.youtube.com/embed/j4clLwXYYXA images: - id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg extension: jpg type: image orderIndex: 0 date: '2022-05-01' sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 attachments: - url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf type: statement_of_information date: '2022-05-01' energyEfficiencyRating: 2 Rent Listing Currently on the Market: value: propertyId: '1234567' listings: - listingId: '7654321' attributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 floorArea: 143 landArea: 615 propertyType: unit propertySubType: unit yearBuilt: 1920 features: - builtInRobes - airConditioning - petFriendly description: This stunning apartment is located in the heart of Baulkham Hills firstSeenDate: '2021-09-27' listingType: rent priceDescription: $500 per week listingPrice: 500 status: current source: REA videoUrl: https://www.youtube.com/embed/j4clLwXYYXA images: - id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg extension: jpg type: image orderIndex: 0 date: '2021-09-27' sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 - id: 34868e32cef313f5e4a6aed0daef7ae19acc95d268cc112ca3dc39cbf91be5a3.jpg extension: jpg type: image orderIndex: 1 date: '2021-09-27' sha: 34868e32cef313f5e4a6aed0daef7ae19acc95d268cc112ca3dc39cbf91be5a3 - id: 14c0fb79c39d4230e6ccf89be69a2b1cc71754c307adeb4bf05a2dc4eeacdfdd.jpg extension: jpg type: image orderIndex: 2 date: '2021-09-27' sha: 14c0fb79c39d4230e6ccf89be69a2b1cc71754c307adeb4bf05a2dc4eeacdfdd attachments: - url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf type: statement_of_information date: '2021-09-27' energyEfficiencyRating: 2 Property with Multiple Listings: value: propertyId: '1234567' listings: - listingId: '7654321' attributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 floorArea: 143 landArea: 615 propertyType: house propertySubType: house yearBuilt: 1951 features: - builtInRobes - airConditioning daysOnSite: 21 description: Beautifully renovated victorian bungalow. firstSeenDate: '2021-09-27' listingType: sale priceDescription: Contact agent listingPrice: 1500000 status: sold saleDate: '2021-10-18' saleValue: 1600000 saleValueSuppressed: false source: REA videoUrl: https://www.youtube.com/embed/j4clLwXYYXA images: - id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg extension: jpg type: image orderIndex: 0 date: '2021-09-27' sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 - id: 34868e32cef313f5e4a6aed0daef7ae19acc95d268cc112ca3dc39cbf91be5a3.jpg extension: jpg type: image orderIndex: 1 date: '2021-09-27' sha: 34868e32cef313f5e4a6aed0daef7ae19acc95d268cc112ca3dc39cbf91be5a3 - id: 14c0fb79c39d4230e6ccf89be69a2b1cc71754c307adeb4bf05a2dc4eeacdfdd.jpg extension: jpg type: image orderIndex: 2 date: '2021-09-27' sha: 14c0fb79c39d4230e6ccf89be69a2b1cc71754c307adeb4bf05a2dc4eeacdfdd attachments: - url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf type: statement_of_information date: '2021-09-27' - listingId: '5435748' attributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 floorArea: 143 landArea: 615 propertyType: house propertySubType: house yearBuilt: 1951 features: - builtInRobes - airConditioning - petFriendly description: Spacious lightfilled home great for a family. firstSeenDate: '2019-07-13' listingType: rent priceDescription: $800 per week listingPrice: 800 status: leased source: REA videoUrl: https://www.youtube.com/embed/j4clLwXYYXA images: - id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg extension: jpg type: image orderIndex: 0 date: '2019-07-13' sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 - id: 34868e32cef313f5e4a6aed0daef7ae19acc95d268cc112ca3dc39cbf91be5a3.jpg extension: jpg type: image orderIndex: 1 date: '2019-07-13' sha: 34868e32cef313f5e4a6aed0daef7ae19acc95d268cc112ca3dc39cbf91be5a3 - id: 14c0fb79c39d4230e6ccf89be69a2b1cc71754c307adeb4bf05a2dc4eeacdfdd.jpg extension: jpg type: image orderIndex: 2 date: '2019-07-13' sha: 14c0fb79c39d4230e6ccf89be69a2b1cc71754c307adeb4bf05a2dc4eeacdfdd attachments: - url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf type: statement_of_information date: '2019-07-13' - listingId: '7654321' attributes: bedrooms: 3 bathrooms: 2 carSpaces: 2 floorArea: 143 landArea: 615 propertyType: house propertySubType: house yearBuilt: 1951 features: - builtInRobes auctionDate: '2017-04-15' auctionTime: 11:00:00 am daysOnSite: 4 description: '' firstSeenDate: '2017-04-11' listingType: sale priceDescription: Offers over $1,000,000 listingPrice: 998000 status: sold saleDate: '2017-04-15' saleValue: 1030000 saleValueSuppressed: false auctionResult: soldAtAuction source: REA images: - id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg extension: jpg type: image orderIndex: 0 date: '2017-04-11' sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 - id: 34868e32cef313f5e4a6aed0daef7ae19acc95d268cc112ca3dc39cbf91be5a3.jpg extension: jpg type: image orderIndex: 1 date: '2017-04-11' sha: 34868e32cef313f5e4a6aed0daef7ae19acc95d268cc112ca3dc39cbf91be5a3 - id: 14c0fb79c39d4230e6ccf89be69a2b1cc71754c307adeb4bf05a2dc4eeacdfdd.jpg extension: jpg type: image orderIndex: 2 date: '2017-04-11' sha: 14c0fb79c39d4230e6ccf89be69a2b1cc71754c307adeb4bf05a2dc4eeacdfdd attachments: - url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf type: statement_of_information date: '2017-04-11' energyEfficiencyRating: 2 No listings data available for the property: value: listings: [] Listings with Agent/Agency details: value: propertyId: '1234567' listings: - listingId: '7654321' address: fullAddress: 1/67 Louisa Rd, Birchgrove, NSW 2041 location: latitude: -34.05438 longitude: 151.6941 attributes: bedrooms: 4 bathrooms: 3 carSpaces: 3 floorArea: 143 landArea: 615 propertyType: house propertySubType: apartment yearBuilt: 1920 features: - airConditioning auctionDate: '2021-10-18' auctionTime: 01:00:00 am auctionResult: passedIn daysOnSite: 23 description: This stunning apartment is located in the heart of Baulkham Hills firstSeenDate: '2021-09-27' listingType: sale priceDescription: Offers from $1M listingPrice: 998000 status: current saleDate: '2021-10-18' saleValue: 1030000 saleValueSuppressed: true source: REA videoUrl: https://www.youtube.com/embed/j4clLwXYYXA images: - id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg extension: jpg type: image orderIndex: 0 date: '2018-09-27' sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 attachments: - url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf type: statement_of_information date: '2018-09-27' energyEfficiencyRating: null agents: - name: Joe Bloggs agentId: '817222' agencies: - name: Estate Agent Name agencyId: AXXYYY headers: Content-Type: schema: enum: - application/json type: string description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertieslistings) for information on error handling.' content: application/json: schema: type: object x-examples: example-1: errors: - code: 7006 description: Number of Results contains invalid characters - Please only include a numeric value properties: errors: type: array items: type: object properties: code: enum: - 7006 - 7007 - 7011 - 7013 - 7014 - 7015 description: Numeric value that defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Briefly describes the type of error that has occured examples: - An incorrect field type has been entered - Please ensure that all values are using the correct field type parameters: type: object description: A set of parameters that are causing the error and the rule that was invoked properties: latestListingOnly: type: string examples: - must be boolean listingType: type: string examples: - must only include allowed values numberOfResults: type: string examples: - must be an integer propertyId: type: string examples: - must be an integer status: type: string examples: - must only include allowed values required: - code - description examples: Sample: value: errors: - code: 7006 level: CRITICAL description: Invalid characters have been included - Please only include allowed characters parameters: listingType: must only include alphabetical characters status: must only include alphabetical characters headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertieslistings) for information on error handling.' content: application/json: schema: type: object x-examples: example-1: errors: - code: 9012 description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Numeric value that defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Briefly describes the type of error that has occured examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again required: - code - description examples: Sample: value: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertieslistings) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9003 description: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint properties: errors: type: array items: type: object properties: code: type: integer enum: - 9003 description: Defines the type of error that has occurred description: type: string description: Overview of the error that has occurred example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - code - description '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertieslistings) for information on error handling.' content: application/json: schema: type: object x-examples: example-1: errors: - code: 7002 description: Unknown id, the entered value does not match a record within our system - Please ensure that the correct value is added to this field properties: errors: type: array items: type: object properties: code: enum: - 7002 description: Numeric value that defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Briefly describes the type of error that has occured examples: - Unknown id, the included value does not match a record within our system - Please ensure that the correct value is added to this field required: - code - description examples: Sample: value: errors: - code: 7002 level: CRITICAL description: Unknown id, the included value does not match a record within our system - Please ensure that the correct value is added to this field headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertieslistings) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly properties: errors: type: array items: type: object properties: code: enum: - 9011 description: Numeric value that defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Briefly describes the type of error that has occured examples: - Rate limit has been exceeded - Please try again shortly required: - code - description examples: {} headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertieslistings) for information on error handling.' servers: - url: https://data.proptrack.com /api/v2/properties/{propertyId}/planning: get: summary: /properties/{propertyId}/planning parameters: - schema: type: integer example: 8282053 in: query name: propertyId description: Unique identifier for a property
Refer to [Obtaining a propertyId](https://developer.proptrack.com.au/docs/apis/guide#obtaining-a-propertyid) required: true - schema: type: string example: Bearer xxxxx in: header name: Authorization description: Provide your bearer token as a string, in the format Bearer {access_token} in the Authorization Header Refer to Authentication required: true responses: '200': description: OK content: application/json: schema: type: object properties: propertyId: type: integer x-stoplight: id: gzxewii1n7vri example: 8282053 zoning: type: array x-stoplight: id: 136onyo50w9gn items: x-stoplight: id: kqu6vgyrnx818 type: object properties: isPrimary: type: boolean x-stoplight: id: buxhr26hhg0lc zoneCode: type: string x-stoplight: id: jsfjwml4rrqqj example: R2 zoneLabel1: type: string x-stoplight: id: xfy8y942cbath example: Low density residential zoneLabel2: type: string x-stoplight: id: n9l216mjhlnmk example: R2 Low Density Residential lgaName: type: string x-stoplight: id: wo9lu3p6gphx4 lgaPlanningUrl: type: - string - 'null' x-stoplight: id: i10aedm7k3j22 example: https://www.cityofparramatta.nsw.gov.au/development/planning/development-control-plans permittedUse: type: array x-stoplight: id: vzbc2rk84fjsp items: x-stoplight: id: w5294z9c4ihhj type: string example: Home occupations permittedUseWithControls: type: array x-stoplight: id: zs498recrak72 items: x-stoplight: id: eds83gdrnyr7l type: string example: Attached dwellings prohibitedUse: type: array x-stoplight: id: 4h9txb2dbh0vx items: x-stoplight: id: 769ljfuwtr70n type: string example: Animal boarding or training establishments sourceDate: type: string x-stoplight: id: jwt1iu0y7k61c format: date example: '2024-03-26' propertyUse: type: - object - 'null' x-stoplight: id: lpzzxfoq79smb properties: permittedUseApartment: type: object x-stoplight: id: uw7z2d07k1fq4 properties: value: x-stoplight: id: l5eq1manpa7ek example: 'true' enum: - 'true' - 'false' - maybe sourceDate: type: string x-stoplight: id: usf3evnauyfqu format: date permittedUseDuplex: type: object x-stoplight: id: ffiptb0r3srkn properties: value: x-stoplight: id: 0cehtg1720l0i enum: - 'true' - 'false' - maybe example: 'true' sourceDate: type: string x-stoplight: id: eqzv85ceji9m8 format: date permittedUseMixedUse: type: object x-stoplight: id: bqs24b1nw98tg properties: value: x-stoplight: id: 4j5d3mcdk6n3h enum: - 'true' - 'false' - maybe example: 'true' sourceDate: type: string x-stoplight: id: d5d2d6v2imbq9 format: date permittedUseTownhouse: type: object x-stoplight: id: ypvc59r4mbp5r properties: value: x-stoplight: id: n5pwncbt5hs6k enum: - 'true' - 'false' - maybe example: 'true' sourceDate: type: string x-stoplight: id: ejg8x9t9gnlce format: date examples: Example 1: value: propertyId: 8282053 zoning: - isPrimary: true zoneCode: R2 zoneLabel1: Low density residential zoneLabel2: R2 Low Density Residential lgaName: string lgaPlanningUrl: https://www.cityofparramatta.nsw.gov.au/development/planning/development-control-plans permittedUse: - Home occupations permittedUseWithControls: - Attached dwellings prohibitedUse: - Animal boarding or training establishments sourceDate: '2024-03-26' propertyUse: permittedUseApartment: value: 'true' sourceDate: '2019-08-24' permittedUseDuplex: value: 'true' sourceDate: '2019-08-24' permittedUseMixedUse: value: 'true' sourceDate: '2019-08-24' permittedUseTownhouse: value: maybe sourceDate: '2019-08-24' '400': description: ' > #### Bad Request (400)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: r7le66zh8v67w items: x-stoplight: id: hjx2b7h7b522b type: object properties: code: x-stoplight: id: bxi3biqyk4f8u enum: - 7004 - 7008 - 7011 description: Defines the type of error that has occurred description: type: string x-stoplight: id: 6ghay4wgxkulh description: Overview of the error that has occurred example: An incorrect field type has been entered - Please ensure that all values are using the correct field type parameters: type: object x-stoplight: id: 7xnsmg3xr6o8l description: A set of parameters that are causing the error and the rule that was invoked properties: propertyId: type: string x-stoplight: id: 8vc5y4xl1l3sm example: must be an integer required: - code - description '401': description: ' > #### Unauthorized (401)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: 846gmdjflhbel items: x-stoplight: id: q0wcvqba2kawb type: object properties: code: x-stoplight: id: c1bdva5f51s0r enum: - 9012 - 9016 description: Defines the type of error that has occurred level: x-stoplight: id: 7b3fjhmy2mqm1 x-deprecated: true enum: - CRITICAL description: type: string x-stoplight: id: ip2gz8ye43efo description: Overview of the error that has occurred example: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again required: - code - description '403': description: ' > #### Forbidden (403)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: hkyda18rsudcx items: x-stoplight: id: ttffyir1ybkf3 type: object properties: code: x-stoplight: id: zh7tigi9kaiq0 enum: - 9003 description: Defines the type of error that has occurred description: type: string x-stoplight: id: yngl3cnc9p9lt description: Overview of the error that has occurred example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - code - description '404': description: ' > #### Not Found (404)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: rflmgrjw6r30c items: x-stoplight: id: 41xpgxe3hwplb type: object properties: code: x-stoplight: id: 6s11oiyf6ex4n enum: - 7002 description: Defines the type of error that has occurred description: type: string x-stoplight: id: eird63ds5ppbh description: Overview of the error that has occurred parameters: type: object x-stoplight: id: 6h9uxuf2b8911 description: A set of parameters that are causing the error and the rule that was invoked properties: propertyId: type: string x-stoplight: id: 8d34l73jq140e example: cannot be found required: - code - description '429': description: ' > #### Too Many Requests (429)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: inksu4sg688w4 items: x-stoplight: id: yzle9v4asb6hh type: object properties: code: x-stoplight: id: nufl4zvbock0h enum: - 9011 description: Defines the type of error that has occurred level: x-stoplight: id: uvetgewo8pu4e x-deprecated: true enum: - CRITICAL description: type: string x-stoplight: id: ogsqejugoy2ht description: Overview of the error that has occurred example: Rate limit has been exceeded - Please try again shortly required: - code - description '500': description: ' > #### Internal Server Error (500)' operationId: get-api-v2-properties-planning x-stoplight: id: t4dcw068k69y4 description: "Endpoint for retrieving planning information for a specific property.
\r\nThis\ \ includes:\r\n* Property Zoning\r\n* Permitted Use\r\n\r\n#### Data Attribution Notice:\r\nThis\ \ endpoint contains State and Territory data which may be subject to approval by the relevant\ \ government department.\r\nDue to licensing agreement requirements, it is necessary to include\ \ data disclaimers and PropTrack branding when displaying this data in a user experience or printable\ \ output.\r\n

\r\nDisclaimer Types: `archistar`,`geoscape`\r\n\r\nPlease refer to [Disclaimers\ \ and Branding](https://developer.proptrack.com.au/docs/apis/disclaimersBranding) for more information\ \ on implementing data source disclaimers in your experience.\r\n\r\n" tags: - Planning parameters: - schema: type: string name: propertyId in: path required: true /api/v2/properties/{propertyId}/tenureType: get: summary: /api/v2/properties/{propertyId}/tenureType parameters: - schema: type: string example: Bearer xxxxx in: header name: Authorization description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true responses: '200': description: OK content: application/json: schema: type: object properties: propertyId: type: integer x-stoplight: id: m9gokv4hbaod4 tenureTypeHistory: type: array x-stoplight: id: 3kjl0kfcd6ble items: x-stoplight: id: hpfdg745f29ud type: object properties: startDate: type: - string - 'null' x-stoplight: id: 4y9lj709ivubu example: '2015-01-01' format: date endDate: type: - string - 'null' x-stoplight: id: u36wi1ueyd8rq format: date example: '2024-12-31' tenureType: x-stoplight: id: r4vh3ehph7rtg enum: - ownerOccupied - renterOccupied example: ownerOccupied examples: Single tenure type: value: propertyId: 8282053 tenureTypeHistory: - startDate: '2015-01-01' endDate: null tenureType: ownerOccupied Tenure History: value: propertyId: 0 tenureTypeHistory: - startDate: '2015-01-01' endDate: '2025-01-01' tenureType: ownerOccupied - startDate: '2025-01-01' endDate: null tenureType: renterOccupied '400': description: ' > #### Bad Request (400)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: a7pv1wt41f4w0 items: x-stoplight: id: lqm2qv8uegzjf type: object properties: code: x-stoplight: id: lnnljss9nc93d enum: - 7004 - 7008 - 7011 description: Defines the type of error that has occurred description: type: string x-stoplight: id: xr0hrivyq13vy description: Overview of the error that has occurred example: An incorrect field type has been entered - Please ensure that all values are using the correct field type parameters: type: object x-stoplight: id: 6vrvs2iwa0k7v description: A set of parameters that are causing the error and the rule that was invoked properties: propertyId: type: string x-stoplight: id: om8f7maax6knd example: must be an integer required: - code - description '401': description: ' > #### Unauthorized (401)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: ysusgtiiltdnh items: x-stoplight: id: ciltcajyuu6i4 type: object properties: code: x-stoplight: id: uggewv2jz4jr2 enum: - 9012 - 9016 description: Defines the type of error that has occurred level: x-stoplight: id: 06a5rvfr5140h x-deprecated: true enum: - CRITICAL description: type: string x-stoplight: id: 3588squqfn4vl description: Overview of the error that has occurred example: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again required: - code - description '403': description: ' > #### Forbidden (403)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: wd47zsexlbpuk items: x-stoplight: id: c6kcexl4jltcg type: object properties: code: x-stoplight: id: o34fma7cxej4v enum: - 9003 description: Defines the type of error that has occurred description: type: string x-stoplight: id: nvcd9p746hri3 description: Overview of the error that has occurred example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - code - description '404': description: ' > #### Not Found (404)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: sdecbxpt90s6u items: x-stoplight: id: qgqgmwvec4dux type: object properties: code: x-stoplight: id: k15mcw6taaq90 enum: - 7002 description: Defines the type of error that has occurred description: type: string x-stoplight: id: 49bumtglgzczn description: Overview of the error that has occurred parameters: type: object x-stoplight: id: lofxlczzupgr8 description: A set of parameters that are causing the error and the rule that was invoked properties: propertyId: type: string x-stoplight: id: ztpw5af9yyrxp example: cannot be found required: - code - description '429': description: ' > #### Too Many Requests (429)' headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object properties: errors: type: array x-stoplight: id: stmkmfssv1g4f items: x-stoplight: id: vj20aoctikk3v type: object properties: code: x-stoplight: id: 23irc6w5rvzf6 enum: - 9011 description: Defines the type of error that has occurred level: x-stoplight: id: i0tjyywokp2ie x-deprecated: true enum: - CRITICAL description: type: string x-stoplight: id: eivpaczt1xu83 description: Overview of the error that has occurred example: Rate limit has been exceeded - Please try again shortly required: - code - description '500': description: ' > #### Internal Server Error (500)' operationId: get-api-v2-properties-tenure x-stoplight: id: 4xjje4lnrraq6 description: "This endpoint provides property tenure type history, indicating if the property is\ \ owner or renter occupied, over time.\r\nThe Tenure Type value is an inferred value based on\ \ information available to PropTrack at a given point in time and is subject to change in response\ \ to new data\r\n\r\n#### Data Attribution Notice:\r\nThis endpoint contains State and Territory\ \ data which may be subject to approval by the relevant government department.\r\nDue to licensing\ \ agreement requirements, it is necessary to include data disclaimers and PropTrack branding when\ \ displaying this data in a user experience or printable output.\r\n

\r\nDisclaimer Types:\ \ `vg`,`serviceAgent`,`proptrackTenureType`\r\n\r\nPlease refer to [Disclaimers and Branding](https://developer.proptrack.com.au/docs/apis/disclaimersBranding)\ \ for more information on implementing data source disclaimers in your experience.\r\n" tags: - Tenure Type parameters: - schema: type: integer name: propertyId in: path required: true description: Unique identifier for a property
Refer to [Obtaining a propertyId](https://developer.proptrack.com.au/docs/apis/guide#obtaining-a-propertyid) example: 8282053 /api/v2/properties/{propertyId}/transactions: get: tags: - Transactions summary: /api/v2/properties/{propertyId}/transactions description: "Retrieves sold transactions for a given property.\r\n\r\n\r\n#### Data Attribution\ \ Notice:\r\nThis endpoint contains State and Territory data which may be subject to approval\ \ by the relevant government department.\r\nDue to licensing agreement requirements, it is necessary\ \ to include data disclaimers and PropTrack branding when displaying this data in a user experience\ \ or printable output.\r\n

\r\nDisclaimer Types: `vg`,`serviceAgent`\r\n\r\nPlease refer\ \ to [Disclaimers and Branding](https://developer.proptrack.com.au/docs/apis/disclaimersBranding)\ \ for more information on implementing data source disclaimers in your experience.\r\n" operationId: transactions parameters: - name: Authorization in: header description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true schema: type: string example: Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO default: Bearer {access_token} - name: latestTransactionOnly in: query description: Return the single most recent transaction schema: type: boolean default: false - name: sourceCategory in: query description: Filter the transaction source schema: enum: - vg - agency - name: propertyId in: path description: Unique identifier for a property
Refer to [Obtaining a propertyId](https://developer.proptrack.com.au/docs/apis/guide#obtaining-a-propertyid) required: true schema: type: string examples: - '123456789' responses: '200': description: ' > #### Success (200)' content: application/json: schema: type: object x-examples: Example 1: propertyId: 123456789 transactions: - sourceCategory: agency transactionDate: '2020-09-23' transferType: partial saleValue: 580000 listingDetails: listingId: '123456789' daysOnMarket: 5 agencyName: - Bob's Real Estate - Jenny's Real Estate agentName: - Bob Smith - Jenny Smith - sourceCategory: vg contractDate: '2020-09-11' transactionDate: '2020-09-14' transferDate: '2020-09-15' transferType: partial saleValue: 390000 listingDetails: listingId: '123456789' daysOnMarket: 6 agencyName: - Bob's Real Estate - Jenny's Real Estate agentName: - Bob Smith - Jenny Smith - sourceCategory: vg contractDate: '2020-09-03' transactionDate: '2020-09-03' transferDate: '2020-09-05' transferType: full saleValue: 330000 listingDetails: listingId: '123456789' daysOnMarket: 8 agencyName: - Bob's Real Estate - Jenny's Real Estate agentName: - Bob Smith - Jenny Smith - sourceCategory: agency transactionDate: '2020-09-01' transferType: partial saleValue: 560000 listingDetails: listingId: '123456789' daysOnMarket: 3 agencyName: - Bob's Real Estate - Jenny's Real Estate agentName: - Bob Smith - Jenny Smith properties: propertyId: type: integer description: Unique identifier for a property examples: - 123456789 transactions: type: array items: type: object properties: sourceCategory: enum: - vg - agency - other description: Source of transaction event data examples: - vg type: string transactionDate: type: string description: Date associated with the transaction event
Format `YYYY-MM-DD` format: date examples: - '2023-01-27' contractDate: type: string description: Date on which the contract for the transaction was signed
Format `YYYY-MM-DD` format: date examples: - '2023-01-25' transferDate: type: string description: Date on which ownership is transferred
Format `YYYY-MM-DD` format: date examples: - '2023-01-25' transferType: enum: - full - multi - partial - nil - other description: Type of transfer
Refer to [Transfer Types](https://developer.proptrack.com.au/docs/apis/guide#transfer-types) examples: - full type: string saleValue: type: integer description: "Price associated with the transaction event
\r\nIf `\"saleValueSuppressed\"\ : true`, then this field will return as `undefined`" examples: - 1350000 saleValueSuppressed: type: boolean x-stoplight: id: 0zx8itumihsdg description: Flags if the saleValue has been suppressed listingDetails: type: object properties: listingId: type: string description: Unique identifier for a listing examples: - '123456789' daysOnMarket: type: integer description: Number of days the listing was advertised before resulting in a transaction examples: - 24 agencyName: type: array description: Name of the responsible agency items: type: string examples: - '"Bob''s Real Estate","Jenny''s Real Estate"' agentName: type: array description: Name of the responsible agent/s items: type: string examples: - '"Bob Smith","Jenny Smith"' required: - transactionDate required: - propertyId examples: Property with 4 transactions: value: propertyId: 123456789 transactions: - sourceCategory: agency transactionDate: '2020-09-23' saleValue: 580000 listingDetails: listingId: '123456789' daysOnMarket: 5 agencyName: - Bob's Real Estate agentName: - Bob Smith - Jenny Smith - sourceCategory: vg contractDate: '2020-09-11' transactionDate: '2020-09-14' transferDate: '2020-09-15' transferType: partial saleValue: 390000 listingDetails: listingId: '123456789' daysOnMarket: 6 agencyName: - Jenny's Real Estate agentName: - Bob Smith - Jenny Smith - sourceCategory: vg contractDate: '2020-09-03' transactionDate: '2020-09-03' transferDate: '2020-09-05' transferType: full saleValue: 330000 listingDetails: listingId: '123456789' daysOnMarket: 8 agencyName: - Bob's Real Estate agentName: - Bob Smith - Jenny Smith - sourceCategory: agency transactionDate: '2020-09-01' saleValue: 560000 listingDetails: listingId: '123456789' daysOnMarket: 3 agencyName: - Jenny's Real Estate agentName: - Bob Smith - Jenny Smith sourceCategory=vg: value: propertyId: 123456789 transactions: - sourceCategory: vg contractDate: '2020-09-11' transactionDate: '2020-09-14' transferDate: '2020-09-15' transferType: partial saleValue: 390000 listingDetails: listingId: '123456789' daysOnMarket: 6 agencyName: - Jenny's Real Estate agentName: - Bob Smith - Jenny Smith - sourceCategory: vg contractDate: '2020-09-03' transactionDate: '2020-09-03' transferDate: '2020-09-05' transferType: full saleValue: 330000 listingDetails: listingId: '123456789' daysOnMarket: 8 agencyName: - Bob's Real Estate - Jenny's Real Estate agentName: - Bob Smith - Jenny Smith sourceCategory=agency: value: propertyId: 123456789 transactions: - sourceCategory: agency transactionDate: '2020-09-23' saleValue: 580000 listingDetails: listingId: '123456789' daysOnMarket: 5 agencyName: - Bob's Real Estate agentName: - Bob Smith - Jenny Smith - sourceCategory: agency transactionDate: '2020-09-01' saleValue: 560000 listingDetails: listingId: '123456789' daysOnMarket: 3 agencyName: - Bob's Real Estate agentName: - Bob Smith - Jenny Smith latestTransactionOnly=true: value: propertyId: 123456789 transactions: - sourceCategory: agency transactionDate: '2020-09-23' saleValue: 580000 listingDetails: listingId: '123456789' daysOnMarket: 5 agencyName: - Bob's Real Estate agentName: - Bob Smith - Jenny Smith Property with no transaction events: value: propertyId: 123456789 transactions: [] headers: Content-Type: schema: enum: - application/json type: string description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 0 level: string description: string parameters: propertyId: string sourceCategory: string latestTransactionOnly: string properties: errors: type: array items: type: object properties: code: enum: - 7004 - 7007 - 7008 - 7011 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - An incorrect field type has been included - Please ensure that all values are using the correct field type parameters: type: object description: A set of parameters that are causing the error and the rule that was invoked properties: propertyId: type: string examples: - must be an integer sourceCategory: type: string examples: - must only include an allowed value latestTransactionOnly: type: string examples: - must be boolean required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9003 description: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint properties: errors: type: array items: type: object properties: code: type: integer enum: - 9003 description: Defines the type of error that has occurred description: type: string description: Overview of the error that has occurred example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - code - description '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 7002 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Unknown id, the included value does not match a record within our system - Please ensure that the correct value is added to this field required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9011 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Rate limit has been exceeded - Please try again shortly required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' servers: - url: https://data.proptrack.com /api/v1/properties/valuations/sale: post: tags: - AVM summary: /api/v1/properties/valuations/sale ~ Enquiry or Origination description: "**AVM Sale - by address:** Get a property price\ \ estimate from PropTrack’s Sale Automated Valuation Model (AVM) using the property address. \n\ \nThe service returns the most up-to-date value estimate, just provide the fullAddress OR address, only provide either not both in the same request.\n\nThis operation\ \ supports two requestType options within the request body\ \ based estimates. Each type uses its own request body parameters, and customers can be enabled\ \ for one or both:\n\n-

Enquiry:

requestType=enquiry

a simplified\ \ version only returning the property valuation details \n ![Sale_Enquiry](../assets/images/AVM-origination.png)\n\ -

Origination:

requestType=origination

offers a detailed\ \ view of what goes into the price estimate including attributes, and supporting valuation data,\ \ with the option to obtain a Sale PDF report\n\n ![Sale_Origination](../assets/images/AVM-SALE-Origination.png)\n\ \n" operationId: v1-properties-valuation-sale parameters: - name: Authorization in: header description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true schema: type: string examples: - Bearer eyJraWQiOiJiYWRmNzUyNC1jYzBkLTQ3YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiOiJKV1QiLCJhbGc example: Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO default: Bearer {access_token} requestBody: description: 'Either `fullAddress` **or** `address` are required in the request, not both. We offer two distinct requestType, for the sale estimates, each type is operated by unique requestType in the body: -

Enquiry:

requestType=enquiry

will service your basic AVM needs by providing all fields you will find our PropTrackpowered experiences -

Origination:

requestType=origination

offers a more detailed view of what goes into the price estimate including attributes, comparable properties and other details ' content: application/json: schema: type: object x-examples: Example 1: fullAddress: 10 Test Street, Sydney NSW 2000 address: lotNumber: Lot21 unitNumber: 2b streetNumber: '10' streetName: Test streetType: St suburb: Sydney state: NSW postCode: '2000' effectiveDate: '2022-06-30' updatedAttributes: bedrooms: 3 bathrooms: 2 carSpaces: 1 propertyType: house landArea: 325 floorArea: 114 additionalInformation: applicantEstimate: 1000000 loanAmount: 800000 customerReference: Abc123 required: - requestType - fullAddress - address properties: requestType: x-stoplight: id: dpjvk9vsiuh3b enum: - enquiry - origination - plus example: enquiry description: "requestType is mandatory for all new customers from Sept 2025, existing\ \ customers can continue without sending, please contact PropTrack support to discuss\ \ options to upgrade. Note: for 'plus' see the AVM Plus endpoint: https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-sale-request-type-plus\ \ \n\n -

Enquiry:

requestType=enquiry\ \ will service your basic AVM needs by providing all fields you will find our\ \ PropTrackpowered experiences\n -

Origination:

\ \ requestType=origination\ \ offers a more detailed view of what goes into the price estimate including attributes,\ \ comparable properties and other details" fullAddress: type: string description: 'Full address of the property, either fullAddress or address not both allowed
Field available in: Enquiry, Origination
' examples: - 1/67 Louisa Rd, Birchgrove, NSW 2041 address: type: object description: 'Structured address of the property, either fullAddress or address not both allowed
Field available in: Enquiry, Origination
' properties: lotNumber: type: string description: 'Lot number of the property
Field available in: Enquiry, Origination
' examples: - Lot 123 unitNumber: type: string description: 'Unit number of the property
Field available in: Enquiry, Origination
' examples: - Unit 1 streetNumber: type: string description: 'Street number of the property
Field available in: Enquiry, Origination
' examples: - '67' streetName: type: string description: 'Street name of the property
Field available in: Enquiry, Origination
' examples: - Louisa streetType: type: string description: 'Street type of the property
Field available in: Enquiry, Origination
' examples: - Rd suburb: type: string description: 'Suburb of the property
Field available in: Enquiry, Origination
' examples: - Birchgrove state: type: string description: 'State of the property
Field available in: Enquiry, Origination
' examples: - NSW postCode: type: string description: 'Postcode of the property
Field available in: Enquiry, Origination
' examples: - '2041' effectiveDate: type: string description: 'Effective date of requested estimate
Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)
Format `YYYY-MM-DD`
Field available in: Origination
' format: date examples: - '2022-06-30' updatedAttributes: type: object description: 'Customer supplied attributes
Refer to [Updated Attributes](https://developer.proptrack.com.au/docs/apis/guide#updated-attributes)
Field available in: Origination
' properties: bedrooms: type: integer description: 'Number of bedrooms
Field available in: Origination
' examples: - 4 bathrooms: type: integer description: 'Number of bathrooms
Field available in: Origination
' examples: - 2 carSpaces: type: integer description: 'Number of car spaces
Field available in: Origination
' examples: - 2 propertyType: enum: - house - unit description: 'Classification of the type of property
Field available in: Origination
' type: string landArea: type: integer description: 'Land space area (measured in m2)
Field available in: Origination
' examples: - 605 floorArea: type: integer description: 'Floor space area (measured in m2)
Field available in: Origination
' examples: - 322 additionalInformation: type: object properties: applicantEstimate: type: integer description: 'Applicant''s estimated value of the property
Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)
Field available in: Origination
' examples: - 1030000 loanAmount: type: integer description: 'Outstanding loan amount on the property
Refer to [Loan Amount](https://developer.proptrack.com.au/docs/apis/guide#loan-amount)
Field available in: Origination
' examples: - 850000 customerReference: type: string description: 'Customer Reference Key
Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)
Field available in: Origination
' examples: - abcd1234 examples: Enquiry example with fullAddress: value: requestType: enquiry fullAddress: 1/67 Louisa Rd, Birchgrove, NSW 2041 Enquiry example with address: value: requestType: enquiry address: lotNumber: Lot 123 unitNumber: Unit 1 streetNumber: '67' streetName: Louisa streetType: Rd suburb: Birchgrove state: NSW postCode: '2041' Origination example with fullAddress: value: requestType: origination fullAddress: 1/67 Louisa Rd, Birchgrove, NSW 2041 Origination example with address: value: requestType: origination address: lotNumber: Lot 123 unitNumber: Unit 1 streetNumber: '67' streetName: Louisa streetType: Rd suburb: Birchgrove state: NSW postCode: '2041' Origination example with full request payload: value: requestType: origination fullAddress: 1/67 Louisa Rd, Birchgrove, NSW 2041 effectiveDate: '2022-06-30' updatedAttributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 propertyType: house landArea: 605 floorArea: 322 additionalInformation: applicantEstimate: 1030000 loanAmount: 850000 customerReference: abcd1234 responses: '200': description: "\n\n> #### Success (200)\n\nBased on the requestType=?\ \ provided, the response is dynamic according to the response payload, \n**Note:** see examples\ \ for the response of enquiry/origination, the mock-up doesn't reflect the requestType.\n\n\ An AVM Sale Report can be generated for requestType=originationfor using the returned\ \ **valuationId**. Simply pass the **valuationId** value into the GET AVM Report endpoint to retrieve a professionally\ \ formatted report. For implementation details, refer to the GET AVM Report.\n" content: application/json: schema: type: object x-examples: Example 1: valuationId: 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: '2022-12-25' effectiveDate: '2022-12-25' propertyId: 123456789 estimatedValue: 785652 fsd: 0.39079999923706055 lowerRangeValue: 712352 upperRangeValue: 875250 usedAttributes: bedrooms: 4 bathrooms: 2 carSpaces: 1 propertyType: house properties: valuationId: type: string description: 'Unique identifier for an AVM valuation.
This can be used to Generate a Report
Field available in: Enquiry, Origination
' format: uuid examples: - 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: type: string description: 'Date of the AVM valuation
Field available in: Enquiry, Origination
Format `YYYY-MM-DD`.
' format: date examples: - '2022-05-22' effectiveDate: type: string format: date examples: - '2022-05-22' description: 'Effective date of requested estimate
Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)
Format `YYYY-MM-DD`.
Field available in: Enquiry, Origination
' fullAddress: type: string description: 'Full address of the property
Field available in: Origination
' examples: - 1/67 Louisa Rd, Birchgrove, NSW 2041 address: type: object description: 'the Structured address of the property, optional extra to the fullAddress
Field available in: Origination
' properties: lotNumber: type: string description: 'Lot number of the propertyFull address of the property
Field available in: Origination
' examples: - Lot 123 unitNumber: type: string description: 'Unit number of the propertyFull address of the property
Field available in: Origination
' examples: - Unit 1 streetNumber: type: string description: 'Street number of the propertyFull address of the property
Field available in: Origination
' examples: - '67' streetName: type: string description: 'Street name of the propertyFull address of the property
Field available in: Origination
' examples: - Louisa streetType: type: string description: 'Street type of the propertyFull address of the property
Field available in: Origination
' examples: - Rd suburb: type: string description: 'Suburb of the propertyFull address of the property
Field available in: Origination
' examples: - Birchgrove state: type: string description: 'State of the propertyFull address of the property
Field available in: Origination
' examples: - NSW postCode: type: string description: 'Postcode of the propertyFull address of the property
Field available in: Origination
' examples: - '2041' matchQuality: enum: - EXCELLENT - GOOD - OK - POOR description: 'Defines the quality of the match returned
Refer to [Match Quality](https://developer.proptrack.com.au/docs/apis/guide#match-quality)Full address of the property
Field available in: Origination
' examples: - EXCELLENT type: string estimatedValue: type: integer description: 'The estimated value for the property
Field available in: Origination
' examples: - 785652 fsd: type: number description: 'Forecast standard deviation of the AVM estimate
Field available in: Origination
' format: float examples: - 0.13907999992370604 upperRangeValue: type: integer description: 'The upper range estimate of the AVM
Field available in: Enquiry, Origination
' examples: - 875625 lowerRangeValue: type: number description: 'The lower range estimate of the AVM
Field available in: Enquiry, Origination
' examples: - 654123 confidenceLevel: enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE description: 'The confidence level, based on the FSD
Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)
Field available in: Enquiry, Origination
' examples: - HIGH CONFIDENCE type: string usedAttributes: type: object description: 'The attributes used for the AVM valuation
Refer to [Updated Attributes](https://developer.proptrack.com.au/docs/apis/guide#updated-attributes)
Field available in: Origination
' properties: bedrooms: type: integer description: 'Number of bedrooms
Field available in: Origination
' examples: - 4 bathrooms: type: integer description: 'Number of bathrooms
Field available in: Origination
' examples: - 2 carSpaces: type: integer description: 'Number of car spaces
Field available in: Origination
' examples: - 2 propertyType: enum: - house - unit description: 'Classification of the type of property
Field available in: Origination
' type: string landArea: type: integer description: 'Land space area (measured in m2)
Field available in: Origination
' examples: - 605 floorArea: type: integer description: 'Floor space area (measured in m2)
Field available in: Origination
' examples: - 322 additionalInformation: type: object description: Optional fields, by provided if included in the request payload properties: applicantEstimate: type: integer description: 'Applicant''s estimated value of the property, if included in the request
Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)
Field available in: Origination
' examples: - 1030000 loanAmount: type: integer description: 'Outstanding loan amount on the property, if included in the request
Refer to [Loan Amount](https://developer.proptrack.com.au/docs/apis/guide#loan-amount)
Field available in: Origination
' examples: - 850000 customerReference: type: string description: 'Customer Reference Key, if included in the request
Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)
Field available in: Origination
' examples: - abcd1234 examples: Enquiry Response: value: valuationId: 67d4274b-85b6-4d4e-ac1b-b32b3539f90b valuationDate: '2025-03-17' effectiveDate: '2025-03-17' estimatedValue: 785652 lowerRangeValue: 930000 upperRangeValue: 1040000 confidenceLevel: HIGH CONFIDENCE Origination response: value: valuationId: 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: '2022-05-22' effectiveDate: '2022-05-22' fullAddress: 1/67 Louisa Rd, Birchgrove, NSW 2041 matchQuality: EXCELLENT estimatedValue: 785652 fsd: 0.13907999992370604 upperRangeValue: 875625 lowerRangeValue: 654123 confidenceLevel: HIGH CONFIDENCE usedAttributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 propertyType: house landArea: 605 floorArea: 322 additionalInformation: applicantEstimate: 1030000 loanAmount: 850000 customerReference: abcd1234 headers: Content-Type: schema: enum: - application/json type: string description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 400 errorLevel: CRITICAL errorMessage: 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - propertyId must be integer value greater than 0 - The address is invalid and not able to be matched errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 400 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' examples: - CRITICAL type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the parameter/s which is causing the error, and the rule that was invoked items: type: string examples: - The address is invalid and not able to be matched errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Numeric value that defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string description: type: string description: Briefly describes the type of error that has occured examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again examples: Example: value: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 403 errorLevel: CRITICAL errorMessage: 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - string errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979" properties: errors: type: array items: type: object properties: errorCode: enum: - 9003 description: Defines the type of error that has occurred type: integer example: 9003 errorMessage: type: string description: Overview of the error that has occurred examples: - 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - errorCode - errorMessage examples: Example 403: value: errors: - errorCode: 9003 errorMessage: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 404 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - The path is incorrect, please adjust errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 examples: Example 1: value: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly properties: errors: type: array items: type: object properties: code: type: number description: Numeric value that defines the type of error that has occurred enum: - 9011 level: type: string description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' enum: - CRITICAL description: type: string example: Rate limit has been exceeded - Please try again shortly description: Briefly describes the type of error that has occured required: - code - level - description '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 500 errorLevel: CRITICAL errorMessage: 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry but our internal server is not able to provide a response at this time errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 500 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry but our internal server is not able to provide a response at this time errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 '504': description: ' > #### Gateway Timeout (504) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: errorCode: enum: - 504 description: Numeric value that defines the type of error that has occurred errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry the Realtime AVM is currently timing out errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 x-examples: Example 1: errors: - errorCode: 504 errorLevel: CRITICAL errorMessage: 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry the Realtime AVM is currently timing out errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 servers: - url: https://data.proptrack.com x-stoplight: id: 0bytgwlru66n4 parameters: [] /api/v1/properties/{propertyId}/valuations/sale?requestType=enquiry or requestType=origination: get: tags: - AVM summary: /api/v1/properties/{propertyId}/valuations/sale?requestType=enquiry or requestType=origination description: "**AVM Sale - by propertyId:**Get a property\ \ price estimate from PropTrack’s Sale Automated Valuation Model (AVM) using a propertyId. \n\n\ The service returns the most up-to-date value estimate for the specified propertyId.\n\nThis operation supports two requestType\ \ options for propertyId based estimates. Each type uses\ \ its own parameters, and customers can be enabled for one or both:\n\n\n-

Enquiry:

requestType=enquiry

a simplified version only returning the property valuation\ \ details \n ![Sale_Enquiry](../assets/images/AVM-origination.png)\n-

Origination:

requestType=origination

offers a detailed view of what goes into\ \ the price estimate including attributes, and supporting valuation data, with the option to obtain\ \ a Sale PDF report\n\n ![Sale_Origination](../assets/images/AVM-SALE-Origination.png)\n\n" operationId: avm-propertyId parameters: - name: Authorization in: header description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true schema: type: string examples: - Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO default: Bearer {access_token} - name: propertyId in: path description: Unique identifier for a property
Refer to [Obtaining a propertyId](https://developer.proptrack.com.au/docs/apis/guide#obtaining-a-propertyid) required: true schema: type: string examples: - '1234567' - schema: type: string enum: - enquiry - origination example: origination in: query name: requestType required: true description: 'the requestType is mandatory for all new customers from Sept 2025, existing customers can continue without sending, please contact PropTrack support to discuss options to upgrade. Note: for ''plus'' see the AVM Plus endpoint: https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-sale-request-type-plus -

Enquiry:

requestType=enquiry will service your basic AVM needs by providing all fields you will find our PropTrackpowered experiences -

Origination:

requestType=origination offers a more detailed view of what goes into the price estimate including attributes, comparable properties and other details' requestBody: content: {} responses: '200': description: "\n\n> #### Success (200)\n\n\nBased on the requestType=?\ \ provided, the response is dynamic according to the response payload, \n**Note:** see examples\ \ for the response of enquiry/origination, the mock-up doesn't reflect the requestType.\n\n\ An AVM Sale Report can be generated for requestType=originationfor using the returned\ \ **valuationId**. Simply pass the **valuationId** value into the GET AVM Report endpoint to retrieve a professionally\ \ formatted report. For implementation details, refer to the GET AVM Report.\n" content: application/json: schema: type: object properties: valuationId: type: string description: 'Unique identifier for an AVM valuation.
This can be used to Generate a Report
Field available in: Enquiry, Origination
' examples: - 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: type: string description: 'Date of the AVM valuation
Field available in: Enquiry, Origination
Format `YYYY-MM-DD`.
' format: date examples: - '2022-12-25' effectiveDate: type: string description: 'Effective date of requested estimate
Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)
Format `YYYY-MM-DD`.
Field available in: Enquiry, Origination
' format: date examples: - '2022-12-25' propertyId: type: integer description: 'Unique identifier for a property
Field available in: Enquiry, Origination' examples: - 1234567 estimatedValue: type: integer description: 'The estimated value for the property
Field available in: Enquiry, Origination
' examples: - 785652 fsd: type: number format: float examples: - 0.39079999923706055 description: 'Forecast standard deviation of the AVM estimate.
Field available in: Origination' confidenceLevel: x-stoplight: id: 878cx4dblu0i0 enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE description: 'The confidence level, based on the FSD
Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)
Field available in: Enquiry, Origination
' upperRangeValue: type: integer examples: - 875250 description: 'The upper range estimate of the AVM.
Field available in: Enquiry, Origination' lowerRangeValue: type: integer description: 'The lower range estimate of the AVM
Field available in: Enquiry, Origination' examples: - 712352 usedAttributes: type: object description: 'The attributes used for the AVM valuation
Fields available in: Origination' properties: bedrooms: type: integer description: 'Number of bedrooms
Field available in: Origination' examples: - 4 bathrooms: type: integer description: 'Number of bathrooms
Field available in: Origination' examples: - 2 carSpaces: type: integer description: 'Number of car spaces
Field available in: Origination' examples: - 2 propertyType: enum: - house - unit description: 'Classification of the type of property
Field available in: Origination' examples: - house type: string examples: Enquiry Response: value: valuationId: 67d4274b-85b6-4d4e-ac1b-b32b3539f90b valuationDate: '2025-03-17' effectiveDate: '2025-03-17' estimatedValue: 785652 lowerRangeValue: 930000 upperRangeValue: 1040000 confidenceLevel: HIGH CONFIDENCE 'Origination: response': value: valuationId: 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: '2025-03-17' effectiveDate: '2025-03-17' propertyId: 1234567 estimatedValue: 785652 fsd: 0.39079999923706055 confidenceLevel: HIGH CONFIDENCE upperRangeValue: 875250 lowerRangeValue: 712352 usedAttributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 propertyType: house headers: Content-Type: schema: enum: - application/json type: string description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '201': description: Created content: application/json: schema: type: object properties: dddd: type: string x-stoplight: id: ucwcs4by83n1b '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 400 errorLevel: CRITICAL errorMessage: 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - propertyId valid errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 400 description: Numeric value that defines the type of error that has occurred examples: - 400 type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' examples: - CRITICAL type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the parameter/s which is causing the error, and the rule that was invoked items: type: string examples: - 'Invalid Valuation ID: 29930cff-49ec-4ef5-83a6974d5e04300e' errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Numeric value that defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string description: type: string description: Briefly describes the type of error that has occured examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again examples: Example: value: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 403 errorLevel: CRITICAL errorMessage: 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - string errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979" properties: errors: type: array items: type: object properties: errorCode: enum: - 9003 description: Defines the type of error that has occurred type: integer default: 9003 errorMessage: type: string description: Overview of the error that has occurred examples: - 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - errorCode - errorMessage examples: Example 403: value: errors: - errorCode: 9003 errorMessage: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 404 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - The path is incorrect, please adjust errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 examples: Example 1: value: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly properties: errors: type: array items: type: object properties: code: type: integer description: Numeric value that defines the type of error that has occurred enum: - 9011 level: type: string description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' enum: - CRITICAL description: type: string example: Rate limit has been exceeded - Please try again shortly description: Briefly describes the type of error that has occured required: - code - level - description examples: Example 1: value: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 500 errorLevel: CRITICAL errorMessage: 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry but our internal server is not able to provide a response at this time errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 500 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry but our internal server is not able to provide a response at this time errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 '504': description: ' > #### Gateway Timeout (504) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: errorCode: enum: - 504 description: Numeric value that defines the type of error that has occurred errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry the Realtime AVM is currently timing out errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 x-examples: Example 1: errors: - errorCode: 504 errorLevel: CRITICAL errorMessage: 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry the Realtime AVM is currently timing out errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 servers: - url: https://data.proptrack.com x-stoplight: id: yr2ebx24lmub1 parameters: - schema: type: string name: propertyId in: path required: true /api/v1/properties/{propertyId}/valuations/rent?requestType=enquiry or requestType=origination: get: summary: /api/v1/properties/{propertyId}/valuations/rent?requestType=enquiry or requestType=origination tags: - AVM responses: '200': description: "\n\n> #### Success (200)\n\n\nBased on the requestType=?\ \ provided, the response is dynamic according to the response payload, \n**Note:** see examples\ \ for the response of enquiry/origination, the mock-up doesn't reflect the requestType.\n\n\ An AVM Rental Report can be generated for requestType=originationfor using the returned\ \ **valuationId**. Simply pass the **valuationId** value into the GET AVM Report endpoint to retrieve a professionally\ \ formatted report. For implementation details, refer to the GET AVM Report.\n" headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error content: application/json: schema: type: object x-examples: Example 1: valuationId: 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: '2024-12-01' effectiveDate: '2024-12-01' yield: confidenceLevel: HIGH CONFIDENCE lowerRange: 0.0127 upperRange: 0.0275 rental: lowerRange: 450 upperRange: 750 properties: valuationId: type: string description: 'Unique identifier for an AVM valuation
This can be used to [Generate a Report- only when ready in 2025](https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-sale-pdf)
Field available in: Enquiry
' example: 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: type: - string example: '2024-12-01' format: date description: 'Date of the AVM valuation
Format `YYYY-MM-DD`
Field available in: Enquiry
' effectiveDate: type: string format: date example: '2024-12-01' description: 'Effective date of requested estimate
Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)
Format `YYYY-MM-DD`
Field available in: Enquiry
' rental: type: object description: Investment property rental income ranges and confidence properties: estimatedValue: type: number x-stoplight: id: liuiz0f2026aj example: 550 description: 'The weekly rental estimated value for the property
Field available in: Enquiry, Origination
' lowerRangeValue: type: number example: 450 x-stoplight: id: x6kd8satsslk1 upperRangeValue: type: number description: 'The weekly rental upper range of the AVM
Field available in: Enquiry, Origination
' example: 750 x-stoplight: id: newnf1xm6r60f confidenceLevel: x-stoplight: id: dliw7yx7o6t83 description: 'Rental confidence level
Field available in: Enquiry, Origination
' example: HIGH CONFIDENCE enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE - VERY LOW CONFIDENCE lowerRange: type: number x-stoplight: id: 2c9jdqhxtuj5b deprecated: true description: Replaced with 'lowerRangeValue' end of Feb 2025 upperRange: type: number x-stoplight: id: w6yzry88p7kd4 deprecated: true description: replaced with 'upperRangeValue' end of Feb 2025 examples: Enquiry Response: value: valuationId: 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: '2025-03-17' effectiveDate: '2025-12-17' rental: estimatedValue: 550 lowerRangeValue: 450 upperRangeValue: 750 confidenceLevel: HIGH CONFIDENCE '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 400 errorLevel: CRITICAL errorMessage: 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - propertyId must be integer value greater than 0 - The address is invalid and not able to be matched errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 400 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' examples: - CRITICAL type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the parameter/s which is causing the error, and the rule that was invoked items: type: string examples: - The address is invalid and not able to be matched errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 examples: 400 Sample: value: errors: - errorCode: 400 errorLevel: CRITICAL errorMessage: 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - The address is invalid and not able to be matched errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Numeric value that defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string description: type: string description: Briefly describes the type of error that has occured examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again examples: 401 Sample: value: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 403 errorLevel: CRITICAL errorMessage: 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - string errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979" properties: errors: type: array items: type: object properties: errorCode: enum: - 9003 description: Defines the type of error that has occurred type: integer example: 9003 errorMessage: type: string description: Overview of the error that has occurred examples: - 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - errorCode - errorMessage examples: 403 Sample: value: errors: - errorCode: 9003 errorMessage: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 404 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - The path is incorrect, please adjust errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 examples: 404 Sample: value: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly properties: errors: type: array items: type: object properties: code: type: number description: Numeric value that defines the type of error that has occurred enum: - 9011 level: type: string description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' enum: - CRITICAL description: type: string example: Rate limit has been exceeded - Please try again shortly description: Briefly describes the type of error that has occured required: - code - level - description examples: 429 Sample: value: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 500 errorLevel: CRITICAL errorMessage: 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry but our internal server is not able to provide a response at this time errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 500 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry but our internal server is not able to provide a response at this time errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 examples: 500 Sample: value: errors: - errorCode: 500 errorLevel: CRITICAL errorMessage: 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry but our internal server is not able to provide a response at this time errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 '504': description: ' > #### Gateway Timeout (504) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: errorCode: enum: - 504 description: Numeric value that defines the type of error that has occurred errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry the Realtime AVM is currently timing out errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 x-examples: Example 1: errors: - errorCode: 504 errorLevel: CRITICAL errorMessage: 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry the Realtime AVM is currently timing out errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 examples: 504 Sample: value: errors: - errorCode: 504 errorLevel: CRITICAL errorMessage: 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry the Realtime AVM is currently timing out errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 operationId: avm-propertyId-enquiry x-stoplight: id: aggs2cg1cnt2m description: "**AVM Rental - by propertyId:**Get a Rental\ \ estimate from Proptrack’s Rental Automated Valuation Model (AVM).\n\nJust provide the propertyId\ \ to get the most up-to-date rental estimate.\n\nWe offer two distinct requestType, for the rent estimates, each\ \ type is operated by unique query parameters:\n\n\n-

Enquiry:

\ \ requestType=enquiry\ \

a simplified version only returning the property valuation details... \n ![Rental_Enquiry](../assets/images/enquiry-rent.png)\n\ -

Origination:

requestType=origination

offers a detailed\ \ view of what goes into the price estimate including attributes, yield, leased values and supporting\ \ valuation data, with the option to obtain a Rental PDF report\n\n![Rental_Origination](../assets/images/AVM-Rental-Origination.png)\ \ \n\n\n\n " parameters: - schema: type: string example: Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO default: Bearer {access_token} in: header name: Authorization description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true - schema: type: string enum: - enquiry - origination example: enquiry in: query name: requestType description: 'the rental AVM request type. Note: origination coming soon' required: true parameters: - schema: type: string name: propertyId in: path required: true description: Property Id from address match/suggest /api/v1/properties/valuations/sale ~ requestType=plus: post: tags: - AVM summary: /api/v1/properties/valuations/sale ~ Plus description: "**AVM Plus - by address:** delivers a comprehensive\ \ property price estimate powered by PropTrack’s advanced Automated Valuation Model. It consolidates\ \ both sales and rental insights into a single, streamlined API endpoint.\n\nBy supplying a **fullAddress or address** , you can retrieve the latest and\ \ most accurate valuation available, enabling faster decisions and seamless integration into your\ \ business workflows.\n\n\n\n-

Plus

requestType=plus

offers a detailed\ \ view of what goes into the price estimate for sale and rental including attributes, rental yield,\ \ leased values and supporting valuation data, with the option to obtain a AVM Plus PDF report\n\ \nNote: requestType=plus to be included in the body of the\ \ request!\n\n ![AVM Plus](../assets/images/AVM-Plus.png)\n" operationId: v1-properties-valuation-sale-plus parameters: - name: Authorization in: header description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true schema: type: string examples: - Bearer eyJraWQiOiJiYWRmNzUyNC1jYzBkLTQ3YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiOiJKV1QiLCJhbGc example: Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO default: Bearer {access_token} requestBody: description: 'Either `fullAddress` **or** `address` are required in the request, not both. The requestType=plus, will generate the AVM Plus response containing both Sales and Rental data in the same endpointrequestType in the body: ' content: application/json: schema: type: object x-examples: Example 1: fullAddress: 10 Test Street, Sydney NSW 2000 address: lotNumber: Lot21 unitNumber: 2b streetNumber: '10' streetName: Test streetType: St suburb: Sydney state: NSW postCode: '2000' effectiveDate: '2022-06-30' updatedAttributes: bedrooms: 3 bathrooms: 2 carSpaces: 1 propertyType: house landArea: 325 floorArea: 114 additionalInformation: applicantEstimate: 1000000 loanAmount: 800000 customerReference: Abc123 required: - requestType - fullAddress - address properties: requestType: example: plus description: the requestType is mandatory for AVM Plus default: plus enum: - plus fullAddress: type: string description: 'Full address of the property, either fullAddress or address not both allowed
Field available in: Plus
' examples: - 1/67 Louisa Rd, Birchgrove, NSW 2041 address: type: object description: 'Structured address of the property, either fullAddress or address not both allowed
Field available in: Plus
' properties: lotNumber: type: string description: 'Lot number of the property
Field available in: Plus
' examples: - Lot 123 unitNumber: type: string description: 'Unit number of the property
Field available in: Plus
' examples: - Unit 1 streetNumber: type: string description: 'Street number of the property
Field available in: Plus
' examples: - '67' streetName: type: string description: 'Street name of the property
Field available in: Plus
' examples: - Louisa streetType: type: string description: 'Street type of the property
Field available in: Plus
' examples: - Rd suburb: type: string description: 'Suburb of the property
Field available in: Plus
' examples: - Birchgrove state: type: string description: 'State of the property
Field available in: Plus
' examples: - NSW postCode: type: string description: 'Postcode of the property
Field available in: Plus
' examples: - '2041' effectiveDate: type: string description: 'Effective date of requested estimate
Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)
Format `YYYY-MM-DD`
Field available in: Plus
' format: date examples: - '2022-06-30' example: '2026-02-28' updatedAttributes: type: object description: 'Customer supplied attributes
Refer to [Updated Attributes](https://developer.proptrack.com.au/docs/apis/guide#updated-attributes)
Field available in: Plus
' properties: bedrooms: type: integer description: 'Number of bedrooms
Field available in: Plus
' examples: - 4 bathrooms: type: integer description: 'Number of bathrooms
Field available in: Plus
' examples: - 2 carSpaces: type: integer description: 'Number of car spaces
Field available in: Plus
' examples: - 2 propertyType: enum: - house - unit description: 'Classification of the type of property
Field available in: Plus
' type: string landArea: type: integer description: 'Land space area (measured in m2)
Field available in: Plus
' examples: - 605 floorArea: type: integer description: 'Floor space area (measured in m2)
Field available in: Plus
' examples: - 322 additionalInformation: type: object properties: applicantEstimate: type: integer description: 'Applicant''s estimated value of the property
Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)
Field available in: Plus
' examples: - 1030000 loanAmount: type: integer description: 'Outstanding loan amount on the property
Refer to [Loan Amount](https://developer.proptrack.com.au/docs/apis/guide#loan-amount)
Field available in: Plus
' examples: - 850000 customerReference: type: string description: 'Customer Reference Key
Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)
Field available in: Plus
' examples: - abcd1234 examples: Example 1: value: requestType: plus fullAddress: 1/67 Louisa Rd, Birchgrove, NSW 2041 address: lotNumber: Lot 123 unitNumber: Unit 1 streetNumber: '67' streetName: Louisa streetType: Rd suburb: Birchgrove state: NSW postCode: '2041' effectiveDate: '2022-06-30' updatedAttributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 propertyType: house landArea: 605 floorArea: 322 additionalInformation: applicantEstimate: 1030000 loanAmount: 850000 customerReference: abcd1234 responses: '200': description: ' > #### Success (200) Response delivers comprehensive Sale and Rental data to support informed property insights. An AVM Plus Report can be generated using the returned **valuationId**. Simply pass the **valuationId** value into the GET AVM Report endpoint to retrieve a professionally formatted report. For implementation details, refer to the GET AVM Report. ' content: application/json: schema: type: object x-examples: Example 1: valuationId: 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: '2022-12-25' effectiveDate: '2022-12-25' propertyId: 123456789 estimatedValue: 785652 fsd: 0.39079999923706055 lowerRangeValue: 712352 upperRangeValue: 875250 usedAttributes: bedrooms: 4 bathrooms: 2 carSpaces: 1 propertyType: house properties: valuationId: type: string description: 'Unique identifier for an AVM valuation.
This can be used to Generate a Report
Field available in: Plus
' format: uuid examples: - 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: type: string description: 'Date of the AVM valuation
Field available in: Plus
Format `YYYY-MM-DD`.
' format: date examples: - '2022-05-22' effectiveDate: type: string format: date examples: - '2022-05-22' description: 'Effective date of requested estimate
Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)
Format `YYYY-MM-DD`.
Field available in: Plus
' example: '2026-02-28' propertyId: type: number x-stoplight: id: rwmxdhtez307w example: 1234567 description: 'Unique identifier for a property
Field available in: Plus
' fullAddress: type: string description: 'Full address of the property
Field available in: Plus
' examples: - 1/67 Louisa Rd, Birchgrove, NSW 2041 address: type: object description: 'the Structured address of the property, optional extra to the fullAddress
Field available in: Plus
' properties: lotNumber: type: string description: 'Lot number of the propertyFull address of the property
Field available in: Plus
' examples: - Lot 123 unitNumber: type: string description: 'Unit number of the propertyFull address of the property
Field available in: Plus
' examples: - Unit 1 streetNumber: type: string description: 'Street number of the propertyFull address of the property
Field available in: Plus
' examples: - '67' streetName: type: string description: 'Street name of the propertyFull address of the property
Field available in: Plus
' examples: - Louisa streetType: type: string description: 'Street type of the propertyFull address of the property
Field available in: Plus
' examples: - Rd suburb: type: string description: 'Suburb of the propertyFull address of the property
Field available in: Plus
' examples: - Birchgrove state: type: string description: 'State of the propertyFull address of the property
Field available in: Plus
' examples: - NSW postCode: type: string description: 'Postcode of the propertyFull address of the property
Field available in: Plus
' examples: - '2041' matchQuality: enum: - excellent - good - ok - poor description: 'Defines the quality of the match returned
Refer to [Match Quality](https://developer.proptrack.com.au/docs/apis/guide#match-quality)Full address of the property
Field available in: Plus
' examples: - EXCELLENT type: string estimatedValue: type: number description: 'The SALE estimated value for the property
Field available in: Plus
' examples: - 785652 fsd: type: number description: 'SALE forecast standard deviation of the AVM estimate
Field available in: Plus
' examples: - 0.13907999992370604 confidenceLevel: enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE description: 'The SALE confidence level, based on the FSD
Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)
Field available in: Plus
' examples: - HIGH CONFIDENCE type: string lowerRangeValue: type: number description: 'The SALE lower range estimate of the AVM
Field available in: Plus
' examples: - 654123 upperRangeValue: type: number description: 'The SALE upper range estimate of the AVM
Field available in: Plus
' examples: - 875625 rental: type: object x-stoplight: id: l3c51gs29bvku description: Rental estimate object properties: estimatedValue: type: number x-stoplight: id: 6fyvslo471ikn example: 650 description: 'The Rental weekly estimated value for the property
Field available in: Plus
' fsd: type: number x-stoplight: id: miwv7ipmdpqxg description: 'The Rental forecast standard deviation of the AVM estimate
Field available in: Plus
' example: 0.125 confidenceLevel: x-stoplight: id: ahgbbmeabcgwo description: 'The Rental confidence level, based on the FSD
Field available in: Plus
' example: HIGH CONFIDENCE enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE lowerRangeValue: type: number x-stoplight: id: 28worhgfmohxu description: 'The Rental lower range estimate of the AVM
Field available in: Plus
' example: 550 upperRangeValue: type: number x-stoplight: id: wtqkvic7g230f description: 'The Rental upper range estimate of the AVM
Field available in: Plus
' example: 850 lease: type: object x-stoplight: id: 4l4alrznh86tx description: The last Rental Listing details of the property properties: price: type: number x-stoplight: id: rwqykuiv998ek example: 725 description: The last listing price duration: type: number x-stoplight: id: 72n1l5ismozb9 example: 6 description: period of listing in months, if provided startDate: type: string x-stoplight: id: l4gx76htf13ex example: '2025-12-06' description: 'Date of last lease start ' sourceType: x-stoplight: id: 2ndfxhzz1r7n1 description: source of lease example: agency enum: - listing - agency yield: type: object x-stoplight: id: mjxzl4twwfnee description: 'The last Rental Listing details of the property
Field available in: Plus
' properties: yield: type: number x-stoplight: id: 7tbissdjuiwk7 example: 0.025 description: 'The Rental Yield of the Rental estimate
Field available in: Plus
' fsd: type: number x-stoplight: id: pdkvbaf95gsee example: 0.254 description: 'The Rental Yield forecast standard deviation of the AVM estimate
Field available in: Plus
' confidenceLevel: x-stoplight: id: 8fkdo9j6f5grp description: 'The Rental Yield confidence level, based on the FSD
Field available in: Plus
' example: HIGH CONFIDENCE enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE lowerRangeValue: type: number x-stoplight: id: df13vlqcjyt9d description: 'The Rental Yield lower range value
Field available in: Plus
' example: 0.018 upperRangeValue: type: number x-stoplight: id: x49as3bg2s2jr description: 'The Rental Yield upper range value
Field available in: Plus
' example: 0.03 usedAttributes: type: object description: 'The attributes used for the AVM valuation
Refer to [Updated Attributes](https://developer.proptrack.com.au/docs/apis/guide#updated-attributes)
Field available in: Plus
' properties: bedrooms: type: number description: 'Number of bedrooms
Field available in: Plus
' examples: - 4 bathrooms: type: number description: 'Number of bathrooms
Field available in: Plus
' examples: - 2 carSpaces: type: number description: 'Number of car spaces
Field available in: Plus
' examples: - 2 propertyType: description: 'Classification of the type of property
Field available in: Plus
' example: house enum: - house - unit floorArea: type: number description: 'Floor space area (measured in m2)
Field available in: Plus
' examples: - 322 livingArea: type: number x-stoplight: id: hef9zvur6j6zx example: 125 description: 'Living area (measured in m2), excluding Carspaces
Field available in: Plus
' landArea: type: number description: 'Land space area (measured in m2), not valid if Unit/Strata
Field available in: Plus
' examples: - 605 landUse: x-stoplight: id: 0mi1ajo3b1zrz description: 'Land Use classification of the property
Field available in: Plus
' example: RESIDENTIAL enum: - RESIDENTIAL - OTHER lat: type: number x-stoplight: id: 768ymlpsbijk2 description: 'Latitude (Lat) used as a target point
Field available in: Plus
' example: -35.31788658 lon: type: number x-stoplight: id: oz9sj1zpymi0d description: 'Longitude (Lon) used as a target point
Field available in: Plus
' example: 149.12432323 additionalInformation: type: object description: Optional supplementary information, only included if provided in the request payload. These fields are not required nor used in the valuation but may be used to enhance valuation context when supplied. properties: applicantEstimate: type: number description: 'Applicant''s estimated value of the property
Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)
Field available in: Plus
' examples: - 1030000 customerReference: type: string description: 'Customer supplied reference identifier for tracking or reconciliation purposes
Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)
Field available in: Plus
' examples: - abcd1234 examples: AVM Plus Example: value: valuationId: 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: '2022-05-22' effectiveDate: '2026-02-28' propertyId: 1234567 fullAddress: 1/67 Louisa Rd, Birchgrove, NSW 2041 address: lotNumber: Lot 123 unitNumber: Unit 1 streetNumber: '67' streetName: Louisa streetType: Rd suburb: Birchgrove state: NSW postCode: '2041' matchQuality: excellent estimatedValue: 785652 fsd: 0.13907999992370604 confidenceLevel: HIGH CONFIDENCE lowerRangeValue: 654123 upperRangeValue: 875625 rental: estimatedValue: 650 fsd: 0.125 confidenceLevel: HIGH CONFIDENCE lowerRangeValue: 550 upperRangeValue: 850 lease: price: 725 duration: 6 startDate: '2025-12-06' sourceType: listing yield: yield: 0.025 fsd: 0.254 confidenceLevel: HIGH CONFIDENCE lowerRangeValue: 0.018 upperRangeValue: 0.03 usedAttributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 propertyType: house floorArea: 322 livingArea: 125 landArea: 605 landUse: RESIDENTIAL lat: -35.31788658 lon: 149.12432323 additionalInformation: applicantEstimate: 1030000 customerReference: abcd1234 headers: Content-Type: schema: enum: - application/json type: string description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 400 errorLevel: CRITICAL errorMessage: 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - propertyId must be integer value greater than 0 - The address is invalid and not able to be matched errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 400 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' examples: - CRITICAL type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the parameter/s which is causing the error, and the rule that was invoked items: type: string examples: - The address is invalid and not able to be matched errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Numeric value that defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string description: type: string description: Briefly describes the type of error that has occured examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again examples: Example: value: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 403 errorLevel: CRITICAL errorMessage: 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - string errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979" properties: errors: type: array items: type: object properties: errorCode: enum: - 9003 description: Defines the type of error that has occurred type: integer example: 9003 errorMessage: type: string description: Overview of the error that has occurred examples: - 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - errorCode - errorMessage examples: Example 403: value: errors: - errorCode: 9003 errorMessage: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 404 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - The path is incorrect, please adjust errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 examples: Example 1: value: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly properties: errors: type: array items: type: object properties: code: type: number description: Numeric value that defines the type of error that has occurred enum: - 9011 level: type: string description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' enum: - CRITICAL description: type: string example: Rate limit has been exceeded - Please try again shortly description: Briefly describes the type of error that has occured required: - code - level - description '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 500 errorLevel: CRITICAL errorMessage: 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry but our internal server is not able to provide a response at this time errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 500 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry but our internal server is not able to provide a response at this time errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 '504': description: ' > #### Gateway Timeout (504) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: errorCode: enum: - 504 description: Numeric value that defines the type of error that has occurred errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry the Realtime AVM is currently timing out errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 x-examples: Example 1: errors: - errorCode: 504 errorLevel: CRITICAL errorMessage: 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry the Realtime AVM is currently timing out errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 servers: - url: https://data.proptrack.com x-stoplight: id: 2jf3baoinde0p parameters: [] /api/v1/properties/{propertyId}/valuations/sale?requestType=plus: get: tags: - AVM summary: /api/v1/properties/{propertyId}/valuations/sale?requestType=plus description: " **AVM Plus - by propertyId:** delivers a comprehensive\ \ property price estimate powered by PropTrack’s advanced Automated Valuation Model. It consolidates\ \ both sales and rental insights into a single, streamlined API endpoint.\n\nBy supplying a **propertyId** , you can retrieve the latest and most accurate\ \ valuation available, enabling faster decisions and seamless integration into your business workflows.\n\ \n\n-

Plus

requestType=plus

offers a detailed view of what\ \ goes into the price estimate for sale and rental including attributes, rental yield, leased\ \ values and supporting valuation data, with the option to obtain a AVM Plus PDF report\n\n ![AVM\ \ Plus](../assets/images/AVM-Plus.png)\n\n" operationId: avm-propertyId-plus parameters: - name: Authorization in: header description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true schema: type: string examples: - Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO default: Bearer {access_token} - name: propertyId in: path description: Unique identifier for a property
Refer to [Obtaining a propertyId](https://developer.proptrack.com.au/docs/apis/guide#obtaining-a-propertyid) required: true schema: type: string examples: - '1234567' - schema: type: string example: plus enum: - plus in: query name: requestType description: '**Mandatory:** Specifies the valuation request type, the **plus** requestType is mandatory for all AVM Plus requests.
**Note:** If the requestType included is a ''enquiry'' or ''origination'' then these are treated as a AVM Sale request and not a AVM Plus request' required: true - schema: type: string example: '2026-02-28' format: date in: query name: effectiveDate description: '**Optional:** Effective date of the requested valuation estimate
Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)
Format `YYYY-MM-DD`
' - schema: type: string example: ABC123 in: query name: customerReference description: '**Optional:** Client-defined reference key for tracking or reconciliation purposes. Maximum length: 50 characters
Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)
' - schema: type: number example: 4 in: query name: bedrooms description: '**Optional:** Number of bedrooms used to refine the valuation estimate.' - schema: type: number example: 2 in: query name: bathrooms description: '**Optional:** Number of bathrooms used to refine the valuation estimate.' - schema: type: number example: 1 in: query name: carSpaces description: '**Optional:** Number of car spaces used to refine the valuation estimate.' - schema: type: string example: house enum: - house - unit in: query name: propertyType allowEmptyValue: true description: '**Optional:** Classification of the type of property type
' requestBody: content: {} responses: '200': description: "\n\n> #### Success (200)\nResponse delivers comprehensive\ \ Sale and Rental data to support informed property insights based on the requestType=plus provided, the\ \ response is dynamic according to the response payload, \n**Note:** see examples for the\ \ AVM Plus response.\n\nAn AVM Plus Report can be generated using the returned **valuationId**. Simply pass the **valuationId**\ \ value into the GET AVM Report endpoint to retrieve a professionally formatted report. For\ \ implementation details, refer to the GET AVM Report.\n" content: application/json: schema: type: object properties: valuationId: type: string description: 'Unique identifier for an AVM valuation.
This can be used to Generate a Report
Field available in: Plus' examples: - 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: type: string description: 'Date of the AVM valuation
Field available in: plus, Format `YYYY-MM-DD`.
' format: date examples: - '2022-12-25' effectiveDate: type: string description: 'Effective date of requested estimate
Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)
Format `YYYY-MM-DD`.
Field available in: Plus
' format: date examples: - '2022-12-25' propertyId: type: integer description: 'Unique identifier for a property
Field available in: Plus' examples: - 1234567 matchQuality: x-stoplight: id: ey15xpcjp27ub description: 'Defines the quality of the match returned
Refer to [Match Quality](https://developer.proptrack.com.au/docs/apis/guide#match-quality)Full address of the property
Field available in: Plus
' example: excellent enum: - excellent - good - ok estimatedValue: type: integer description: 'The SALE estimated value for the property
Field available in: Plus
' examples: - 785652 fsd: type: number format: float examples: - 0.39079999923706055 description: 'SALE forecast standard deviation of the AVM estimate.
Field available in: Plus' confidenceLevel: enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE description: 'The SALE confidence level, based on the FSD
Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)
Field available in: Plus
' upperRangeValue: type: integer examples: - 875250 description: 'The SALE upper range estimate of the AVM.
Field available in: Plus' lowerRangeValue: type: integer description: 'The SALE lower range estimate of the AVM
Field available in: Plus' examples: - 712352 rental: type: object x-stoplight: id: 5hcrtx98zsrzi description: Rental estimate properties: estimatedValue: type: integer x-stoplight: id: isz8h6j8g1zdo description: 'The RENTAL weekly estimated value for the property
Field available in: Plus
' example: 650 fsd: type: number x-stoplight: id: 8cfhztyoxo136 description: 'RENTAL forecast standard deviation of the AVM estimate.
Field available in: Plus' example: 0.0828 confidenceLevel: x-stoplight: id: 2vjodjc3pmzig description: 'The RENTAL confidence level, based on the FSD
Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)
Field available in: Plus
' example: MEDIUM CONFIDENCE enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE lowerRangeValue: type: number x-stoplight: id: d38crclfnr70w description: 'The RENTAL upper range estimate of the AVM.
Field available in: Plus' example: 550 upperRangeValue: type: number x-stoplight: id: owfazolcxqzu5 description: 'The RENTAL lower range estimate of the AVM
Field available in: Plus' example: 850 lease: type: object x-stoplight: id: xhqmzzrihez3a description: The last Rental Listing details of the property properties: price: type: number x-stoplight: id: is9cj0zwpl1ie description: The last listing price example: 850 duration: type: number x-stoplight: id: lsieaqoq9461f description: period of listing in months, if provided example: 6 startDate: type: string x-stoplight: id: 7moqn3gq00918 description: 'Date of last lease start ' example: '2023-10-31' sourceType: x-stoplight: id: bpve623cdeivv description: source of lease example: listing enum: - listing - agency yield: type: object x-stoplight: id: cpisfngtsy42n description: Rental Yield properties: yield: type: number x-stoplight: id: xvbt6l6idsjce example: 0.039 description: 'RENTAL Yield of the AVM estimate.
Field available in: Plus' fsd: type: number x-stoplight: id: j7a0t0ffpe4ni example: 0.121 description: 'RENTAL Yield forecast standard deviation of the AVM estimate.
Field available in: Plus' confidenceLevel: x-stoplight: id: bdgoi3wp2wt9d description: 'The RENTAL Yield confidence level, based on the FSD
Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)
Field available in: Plus
' example: MEDIUM CONFIDENCE enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE lowerRangeValue: type: number x-stoplight: id: ecex77yk8021v description: 'The RENTAL Yield lower range estimate of the AVM.
Field available in: Plus' upperRangeValue: type: number x-stoplight: id: spl38zn3n3pkg description: 'The RENTAL Yield Upper range estimate of the AVM
Field available in: Plus' usedAttributes: type: object description: 'The attributes used for the AVM valuation
Fields available in: Plus' properties: bedrooms: type: number description: 'Number of bedrooms
Field available in: Plus' examples: - 4 bathrooms: type: number description: 'Number of bathrooms
Field available in: Plus' examples: - 2 carSpaces: type: number description: 'Number of car spaces
Field available in: Plus' examples: - 2 propertyType: enum: - house - unit description: 'Classification of the type of property
Field available in: Plus' examples: - house type: string lat: type: number x-stoplight: id: nzna8dr1q30tn example: -35.31788658 description: 'Latitude (Lat) used as a target point ' lon: type: number x-stoplight: id: vsdj7te1ct1b7 example: 149.12432323 description: Longitude (Lon) used as a target point landUse: x-stoplight: id: jipp1m84fg8rb example: RESIDENTIAL description: Land Use classification of the property enum: - RESIDENTIAL - OTHER floorArea: type: number x-stoplight: id: b3mkwjelp1sx1 description: Floor space area (measured in m2) example: 87 livingArea: type: number x-stoplight: id: w02j4r4les41k example: 125 description: Living area (measured in m2), excluding Carspaces landArea: type: number x-stoplight: id: fini0um9tvfi3 example: 785 description: Land space area (measured in m2), not valid if Unit/Strata additionalInformation: type: object x-stoplight: id: v24njyv6qf1ef description: Optional supplementary information, only included if provided in the request payload. These fields are not required nor used in the valuation but may be used to enhance valuation context when supplied. properties: applicantEstimate: type: number x-stoplight: id: xsjb0gopihccd description: 'Applicant''s estimated value of the property
Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)
Field available in: Plus
' customerReference: type: string x-stoplight: id: do8ma4ue13xxa description: 'Customer‑supplied reference identifier for tracking or reconciliation purposes
Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)
Field available in: Plus
' examples: AVM Plus Example: value: valuationId: 7ca6f369-5a3a-43cf-813e-b8fd3b10ad44 effectiveDate: '2025-01-05' valuationDate: '2026-02-04' propertyId: 2885938 estimatedValue: 1357053 fsd: 0.09 confidenceLevel: HIGH CONFIDENCE lowerRangeValue: 1230000 upperRangeValue: 1480000 rental: fsd: 0.0835 estimatedValue: 1008 confidenceLevel: HIGH CONFIDENCE lowerRangeValue: 920 upperRangeValue: 1090 lease: price: 800 duration: 6 startDate: '2022-03-04' sourceType: listing yield: fsd: 0.121 yield: 0.039 confidenceLevel: HIGH CONFIDENCE lowerRangeValue: 0.034 upperRangeValue: 0.044 usedAttributes: lat: -38.02321285 lon: 145.10493289 landUse: RESIDENTIAL bedrooms: 4 landArea: 300.5 bathrooms: 5 carSpaces: 2 floorArea: 250.5 yearBuilt: 1999 livingArea: 541 propertyType: unit additionalInformation: loanAmount: 200000 applicantEstimate: 1579455 customerReference: RVT123 headers: Content-Type: schema: enum: - application/json type: string description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 400 errorLevel: CRITICAL errorMessage: 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - propertyId valid errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 400 description: Numeric value that defines the type of error that has occurred examples: - 400 type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' examples: - CRITICAL type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the parameter/s which is causing the error, and the rule that was invoked items: type: string examples: - 'Invalid Valuation ID: 29930cff-49ec-4ef5-83a6974d5e04300e' errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Numeric value that defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string description: type: string description: Briefly describes the type of error that has occured examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again examples: Example: value: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 403 errorLevel: CRITICAL errorMessage: 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - string errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979" properties: errors: type: array items: type: object properties: errorCode: enum: - 9003 description: Defines the type of error that has occurred type: integer default: 9003 errorMessage: type: string description: Overview of the error that has occurred examples: - 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - errorCode - errorMessage examples: Example 403: value: errors: - errorCode: 9003 errorMessage: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 404 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - The path is incorrect, please adjust errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 examples: Example 1: value: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly properties: errors: type: array items: type: object properties: code: type: integer description: Numeric value that defines the type of error that has occurred enum: - 9011 level: type: string description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' enum: - CRITICAL description: type: string example: Rate limit has been exceeded - Please try again shortly description: Briefly describes the type of error that has occured required: - code - level - description examples: Example 1: value: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 500 errorLevel: CRITICAL errorMessage: 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry but our internal server is not able to provide a response at this time errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 500 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry but our internal server is not able to provide a response at this time errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 '504': description: ' > #### Gateway Timeout (504) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: errorCode: enum: - 504 description: Numeric value that defines the type of error that has occurred errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry the Realtime AVM is currently timing out errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 x-examples: Example 1: errors: - errorCode: 504 errorLevel: CRITICAL errorMessage: 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry the Realtime AVM is currently timing out errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 servers: - url: https://data.proptrack.com x-stoplight: id: p3qfmyozbl9vw parameters: - schema: type: string name: propertyId in: path required: true /api/v1/properties/valuations/sale ~ Pro: post: tags: - AVM summary: /api/v1/properties/valuations/sale ~ Pro description: "**AVM Pro - by address:** delivers a comprehensive\ \ property price estimate powered by PropTrack’s advanced Automated Valuation Model. It consolidates\ \ both sales, rental and environmental hazards insights into a single, streamlined API endpoint.\n\ \nBy supplying a **fullAddress or address** , you can retrieve\ \ the latest and most accurate valuation available, enabling faster decisions and seamless integration\ \ into your business workflows.\n\n\n-

Plus

requestType=pro\ \

offers a detailed view of what goes into the price estimate for sale, rental, rental and\ \ environmental hazards including attributes, rental yield, leased values and supporting valuation\ \ data, with the option to obtain a AVM Pro PDF report\n\n\nNote:\ \ requestType=pro\ \ to be included in the body of the request!\n\n\n ![AVM Pro](../assets/images/AVM_PRO.png)\n" operationId: v1-properties-valuation-sale-pro parameters: - name: Authorization in: header description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true schema: type: string examples: - Bearer eyJraWQiOiJiYWRmNzUyNC1jYzBkLTQ3YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiOiJKV1QiLCJhbGc example: Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO default: Bearer {access_token} requestBody: description: 'Either `fullAddress` **or** `address` are required in the request, not both. The requestType=pro, will generate the AVM Pro response containing both Sales, rental and environmental hazards data in the same endpointrequestType in the body: ' content: application/json: schema: type: object x-examples: Example 1: fullAddress: 10 Test Street, Sydney NSW 2000 address: lotNumber: Lot21 unitNumber: 2b streetNumber: '10' streetName: Test streetType: St suburb: Sydney state: NSW postCode: '2000' effectiveDate: '2022-06-30' updatedAttributes: bedrooms: 3 bathrooms: 2 carSpaces: 1 propertyType: house landArea: 325 floorArea: 114 additionalInformation: applicantEstimate: 1000000 loanAmount: 800000 customerReference: Abc123 required: - requestType - fullAddress - address properties: requestType: example: pro description: the requestType is mandatory for AVM Pro default: pro enum: - pro fullAddress: type: string description: 'Full address of the property, either fullAddress or address not both allowed
Field available in: Pro
' examples: - 1/67 Louisa Rd, Birchgrove, NSW 2041 address: type: object description: 'Structured address of the property, either fullAddress or address not both allowed
Field available in: Pro
' properties: lotNumber: type: string description: 'Lot number of the property
Field available in: Pro
' examples: - Lot 123 unitNumber: type: string description: 'Unit number of the property
Field available in: Pro
' examples: - Unit 1 streetNumber: type: string description: 'Street number of the property
Field available in: Pro
' examples: - '67' streetName: type: string description: 'Street name of the property
Field available in: Pro
' examples: - Louisa streetType: type: string description: 'Street type of the property
Field available in: Pro
' examples: - Rd suburb: type: string description: 'Suburb of the property
Field available in: Pro
' examples: - Birchgrove state: type: string description: 'State of the property
Field available in: Pro
' examples: - NSW postCode: type: string description: 'Postcode of the property
Field available in: Pro
' examples: - '2041' effectiveDate: type: string description: 'Effective date of requested estimate
Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)
Format `YYYY-MM-DD`
Field available in: Pro
' format: date examples: - '2022-06-30' example: '2026-02-28' updatedAttributes: type: object description: 'Customer supplied attributes
Refer to [Updated Attributes](https://developer.proptrack.com.au/docs/apis/guide#updated-attributes)
Field available in: Pro
' properties: bedrooms: type: integer description: 'Number of bedrooms
Field available in: Pro
' examples: - 4 bathrooms: type: integer description: 'Number of bathrooms
Field available in: Pro
' examples: - 2 carSpaces: type: integer description: 'Number of car spaces
Field available in: Pro
' examples: - 2 propertyType: enum: - house - unit description: 'Classification of the type of property
Field available in: Pro
' type: string landArea: type: integer description: 'Land space area (measured in m2)
Field available in: Pro
' examples: - 605 floorArea: type: integer description: 'Floor space area (measured in m2)
Field available in: Pro
' examples: - 322 additionalInformation: type: object properties: applicantEstimate: type: integer description: 'Applicant''s estimated value of the property
Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)
Field available in: Pro
' examples: - 1030000 loanAmount: type: integer description: 'Outstanding loan amount on the property
Refer to [Loan Amount](https://developer.proptrack.com.au/docs/apis/guide#loan-amount)
Field available in: Pro
' examples: - 850000 customerReference: type: string description: 'Customer Reference Key
Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)
Field available in: Pro
' examples: - abcd1234 examples: Example 1: value: requestType: pro fullAddress: 1/67 Louisa Rd, Birchgrove, NSW 2041 address: lotNumber: Lot 123 unitNumber: Unit 1 streetNumber: '67' streetName: Louisa streetType: Rd suburb: Birchgrove state: NSW postCode: '2041' effectiveDate: '2022-06-30' updatedAttributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 propertyType: house landArea: 605 floorArea: 322 additionalInformation: applicantEstimate: 1030000 loanAmount: 850000 customerReference: abcd1234 responses: '200': description: ' > #### Success (200) Response delivers comprehensive Sale, Rental and environmental hazards data to support informed property insights. An AVM Pro Report can be generated using the returned **valuationId**. Simply pass the **valuationId** value into the GET AVM Report endpoint to retrieve a professionally formatted report. For implementation details, refer to the GET AVM Report. ' content: application/json: schema: type: object x-examples: Example 1: valuationId: 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: '2022-12-25' effectiveDate: '2022-12-25' propertyId: 123456789 estimatedValue: 785652 fsd: 0.39079999923706055 lowerRangeValue: 712352 upperRangeValue: 875250 usedAttributes: bedrooms: 4 bathrooms: 2 carSpaces: 1 propertyType: house properties: valuationId: type: string description: 'Unique identifier for an AVM valuation.
This can be used to Generate a Report
Field available in: Plus
' format: uuid examples: - 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: type: string description: 'Date of the AVM valuation
Field available in: Plus
Format `YYYY-MM-DD`.
' format: date examples: - '2022-05-22' effectiveDate: type: string format: date examples: - '2022-05-22' description: 'Effective date of requested estimate
Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)
Format `YYYY-MM-DD`.
Field available in: Plus
' example: '2026-02-28' propertyId: type: number example: 1234567 description: 'Unique identifier for a property
Field available in: Plus
' fullAddress: type: string description: 'Full address of the property
Field available in: Plus
' examples: - 1/67 Louisa Rd, Birchgrove, NSW 2041 address: type: object description: 'the Structured address of the property, optional extra to the fullAddress
Field available in: Plus
' properties: lotNumber: type: string description: 'Lot number of the propertyFull address of the property
Field available in: Plus
' examples: - Lot 123 unitNumber: type: string description: 'Unit number of the propertyFull address of the property
Field available in: Plus
' examples: - Unit 1 streetNumber: type: string description: 'Street number of the propertyFull address of the property
Field available in: Plus
' examples: - '67' streetName: type: string description: 'Street name of the propertyFull address of the property
Field available in: Plus
' examples: - Louisa streetType: type: string description: 'Street type of the propertyFull address of the property
Field available in: Plus
' examples: - Rd suburb: type: string description: 'Suburb of the propertyFull address of the property
Field available in: Plus
' examples: - Birchgrove state: type: string description: 'State of the propertyFull address of the property
Field available in: Plus
' examples: - NSW postCode: type: string description: 'Postcode of the propertyFull address of the property
Field available in: Plus
' examples: - '2041' matchQuality: enum: - excellent - good - ok - poor description: 'Defines the quality of the match returned
Refer to [Match Quality](https://developer.proptrack.com.au/docs/apis/guide#match-quality)Full address of the property
Field available in: Plus
' examples: - EXCELLENT type: string estimatedValue: type: number description: 'The SALE estimated value for the property
Field available in: Plus
' examples: - 785652 fsd: type: number description: 'SALE forecast standard deviation of the AVM estimate
Field available in: Plus
' examples: - 0.13907999992370604 confidenceLevel: enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE description: 'The SALE confidence level, based on the FSD
Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)
Field available in: Plus
' examples: - HIGH CONFIDENCE type: string lowerRangeValue: type: number description: 'The SALE lower range estimate of the AVM
Field available in: Plus
' examples: - 654123 upperRangeValue: type: number description: 'The SALE upper range estimate of the AVM
Field available in: Plus
' examples: - 875625 rental: type: object description: Rental estimate object properties: estimatedValue: type: number example: 650 description: 'The Rental weekly estimated value for the property
Field available in: Plus
' fsd: type: number description: 'The Rental forecast standard deviation of the AVM estimate
Field available in: Plus
' example: 0.125 confidenceLevel: description: 'The Rental confidence level, based on the FSD
Field available in: Plus
' example: HIGH CONFIDENCE enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE lowerRangeValue: type: number description: 'The Rental lower range estimate of the AVM
Field available in: Plus
' example: 550 upperRangeValue: type: number description: 'The Rental upper range estimate of the AVM
Field available in: Plus
' example: 850 lease: type: object description: The last Rental Listing details of the property properties: price: type: number example: 725 description: The last listing price duration: type: number example: 6 description: period of listing in months, if provided startDate: type: string example: '2025-12-06' description: 'Date of last lease start ' sourceType: description: source of lease example: agency enum: - listing - agency yield: type: object description: 'The last Rental Listing details of the property
Field available in: Plus
' properties: yield: type: number example: 0.025 description: 'The Rental Yield of the Rental estimate
Field available in: Plus
' fsd: type: number example: 0.254 description: 'The Rental Yield forecast standard deviation of the AVM estimate
Field available in: Plus
' confidenceLevel: description: 'The Rental Yield confidence level, based on the FSD
Field available in: Plus
' example: HIGH CONFIDENCE enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE lowerRangeValue: type: number description: 'The Rental Yield lower range value
Field available in: Plus
' example: 0.018 upperRangeValue: type: number description: 'The Rental Yield upper range value
Field available in: Plus
' example: 0.03 usedAttributes: type: object description: 'The attributes used for the AVM valuation
Refer to [Updated Attributes](https://developer.proptrack.com.au/docs/apis/guide#updated-attributes)
Field available in: Plus
' properties: bedrooms: type: number description: 'Number of bedrooms
Field available in: Plus
' examples: - 4 bathrooms: type: number description: 'Number of bathrooms
Field available in: Plus
' examples: - 2 carSpaces: type: number description: 'Number of car spaces
Field available in: Plus
' examples: - 2 propertyType: description: 'Classification of the type of property
Field available in: Plus
' example: house enum: - house - unit floorArea: type: number description: 'Floor space area (measured in m2)
Field available in: Plus
' examples: - 322 floorArea_copy: type: number description: 'Floor space area (measured in m2)
Field available in: Plus
' examples: - 322 livingArea: type: number example: 125 description: 'Living area (measured in m2), excluding Carspaces
Field available in: Plus
' landArea: type: number description: 'Land space area (measured in m2), not valid if Unit/Strata
Field available in: Plus
' examples: - 605 landUse: description: 'Land Use classification of the property
Field available in: Plus
' example: RESIDENTIAL enum: - RESIDENTIAL - OTHER lat: type: number description: 'Latitude (Lat) used as a target point
Field available in: Plus
' example: -35.31788658 lon: type: number description: 'Longitude (Lon) used as a target point
Field available in: Plus
' example: 149.12432323 additionalInformation: type: object description: Optional supplementary information, only included if provided in the request payload. These fields are not required nor used in the valuation but may be used to enhance valuation context when supplied. properties: applicantEstimate: type: number description: 'Applicant''s estimated value of the property
Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)
Field available in: Plus
' examples: - 1030000 customerReference: type: string description: 'Customer supplied reference identifier for tracking or reconciliation purposes
Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)
Field available in: Plus
' examples: - abcd1234 propertyRisks: type: object x-stoplight: id: ieyi3ag66okc1 description: Environmental hazards, include where property is subject to flood, fire or heritage overlays that may impact upon the property. Multiple data sources are available, plus discuss with your account manager for your needs. properties: bushfire: type: object x-stoplight: id: t5ehk1rrw2blf properties: status: type: string x-stoplight: id: nufwlae7d12zm description: If the property is subject to Bush fire. Base source values are 'true', 'false' & 'unknown" example: 'false' flood: type: object x-stoplight: id: l4vgnbldnvjl3 properties: status: type: string x-stoplight: id: cm1llto8kzm51 description: If the property is subject to flood zone. Base source values are 'true', 'false' & 'unknown" example: 'false' heritageItem: type: object x-stoplight: id: 7mtbsdtwnj39y properties: status: type: string x-stoplight: id: ltwzxwnle1hw5 description: "If the property has a heritage overlay.\nHeritage overlays protect\ \ buildings, sites of architectural significance.\n\n Base source values\ \ are 'true', 'false' & 'unknown\"" example: 'false' examples: AVM Pro Example: value: valuationId: 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: '2022-05-22' effectiveDate: '2026-02-28' propertyId: 1234567 fullAddress: 1/67 Louisa Rd, Birchgrove, NSW 2041 address: lotNumber: Lot 123 unitNumber: Unit 1 streetNumber: '67' streetName: Louisa streetType: Rd suburb: Birchgrove state: NSW postCode: '2041' matchQuality: excellent estimatedValue: 785652 fsd: 0.13907999992370604 confidenceLevel: HIGH CONFIDENCE lowerRangeValue: 654123 upperRangeValue: 875625 rental: estimatedValue: 650 fsd: 0.125 confidenceLevel: HIGH CONFIDENCE lowerRangeValue: 550 upperRangeValue: 850 lease: price: 725 duration: 6 startDate: '2025-12-06' sourceType: listing yield: yield: 0.025 fsd: 0.254 confidenceLevel: HIGH CONFIDENCE lowerRangeValue: 0.018 upperRangeValue: 0.03 propertyRisks: bushfire: status: 'false' flood: status: 'false' heritageItem: status: 'false' usedAttributes: bedrooms: 4 bathrooms: 2 carSpaces: 2 propertyType: house floorArea: 322 livingArea: 125 landArea: 605 landUse: RESIDENTIAL lat: -35.31788658 lon: 149.12432323 additionalInformation: applicantEstimate: 1030000 customerReference: abcd1234 headers: Content-Type: schema: enum: - application/json type: string description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 400 errorLevel: CRITICAL errorMessage: 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - propertyId must be integer value greater than 0 - The address is invalid and not able to be matched errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 400 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' examples: - CRITICAL type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the parameter/s which is causing the error, and the rule that was invoked items: type: string examples: - The address is invalid and not able to be matched errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Numeric value that defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string description: type: string description: Briefly describes the type of error that has occured examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again examples: Example: value: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 403 errorLevel: CRITICAL errorMessage: 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - string errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979" properties: errors: type: array items: type: object properties: errorCode: enum: - 9003 description: Defines the type of error that has occurred type: integer example: 9003 errorMessage: type: string description: Overview of the error that has occurred examples: - 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - errorCode - errorMessage examples: Example 403: value: errors: - errorCode: 9003 errorMessage: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 404 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - The path is incorrect, please adjust errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 examples: Example 1: value: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly properties: errors: type: array items: type: object properties: code: type: number description: Numeric value that defines the type of error that has occurred enum: - 9011 level: type: string description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' enum: - CRITICAL description: type: string example: Rate limit has been exceeded - Please try again shortly description: Briefly describes the type of error that has occured required: - code - level - description '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 500 errorLevel: CRITICAL errorMessage: 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry but our internal server is not able to provide a response at this time errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 500 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry but our internal server is not able to provide a response at this time errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 '504': description: ' > #### Gateway Timeout (504) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: errorCode: enum: - 504 description: Numeric value that defines the type of error that has occurred errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry the Realtime AVM is currently timing out errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 x-examples: Example 1: errors: - errorCode: 504 errorLevel: CRITICAL errorMessage: 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry the Realtime AVM is currently timing out errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 servers: - url: https://data.proptrack.com x-stoplight: id: 3944db8179qnm parameters: [] /api/v1/properties/{propertyId}/valuations/sale?requestType=pro: get: tags: - AVM summary: /api/v1/properties/{propertyId}/valuations/sale?requestType=pro description: " **AVM Pro - by propertyId:** delivers a comprehensive\ \ property price estimate powered by PropTrack’s advanced Automated Valuation Model. It consolidates\ \ both sales, rental and environmental hazards into a single, streamlined API endpoint.\n\nBy\ \ supplying a **propertyId** , you can retrieve the latest\ \ and most accurate valuation available, enabling faster decisions and seamless integration into\ \ your business workflows.\n\n\n-

Pro

requestType=pro

offers a detailed\ \ view of what goes into the price estimate for sale, rental and environmental hazards including\ \ attributes, rental yield, leased values and supporting valuation data, with the option to obtain\ \ a AVM Pro PDF report\n\n ![AVM Pro](../assets/images/AVM_PRO.png)\n\n" operationId: avm-propertyId-pro parameters: - name: Authorization in: header description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the Authorization Header
Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token) required: true schema: type: string examples: - Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO default: Bearer {access_token} - name: propertyId in: path description: Unique identifier for a property
Refer to [Obtaining a propertyId](https://developer.proptrack.com.au/docs/apis/guide#obtaining-a-propertyid) required: true schema: type: string examples: - '1234567' - schema: type: string example: pro enum: - pro in: query name: requestType description: '**Mandatory:** Specifies the valuation request type, the **pro** requestType is mandatory for all AVM Pro requests.
**Note:** If the requestType included is a ''enquiry'' or ''origination'' then these are treated as a AVM Sale request and not a AVM Pro request' required: true - schema: type: string example: '2026-02-28' format: date in: query name: effectiveDate description: '**Optional:** Effective date of the requested valuation estimate
Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)
Format `YYYY-MM-DD`
' - schema: type: string example: ABC123 in: query name: customerReference description: '**Optional:** Client-defined reference key for tracking or reconciliation purposes. Maximum length: 50 characters
Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)
' - schema: type: number example: 4 in: query name: bedrooms description: '**Optional:** Number of bedrooms used to refine the valuation estimate.' - schema: type: number example: 2 in: query name: bathrooms description: '**Optional:** Number of bathrooms used to refine the valuation estimate.' - schema: type: number example: 1 in: query name: carSpaces description: '**Optional:** Number of car spaces used to refine the valuation estimate.' - schema: type: string example: house enum: - house - unit in: query name: propertyType allowEmptyValue: true description: '**Optional:** Classification of the type of property type
' requestBody: content: {} responses: '200': description: "\n\n> #### Success (200)\nResponse delivers comprehensive\ \ Sale, rental and environmental hazards data to support informed property insights based\ \ on the requestType=pro\ \ provided, the response is dynamic according to the response payload, \n**Note:** see examples\ \ for the AVM Pro response.\n\nAn AVM Pro Report can be generated using the returned **valuationId**. Simply pass the **valuationId** value into the GET AVM Report endpoint to retrieve a professionally\ \ formatted report. For implementation details, refer to the GET AVM Report.\n" content: application/json: schema: type: object properties: valuationId: type: string description: 'Unique identifier for an AVM valuation.
This can be used to Generate a Report
Field available in: Pro' examples: - 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2 valuationDate: type: string description: 'Date of the AVM valuation
Field available in: Pro, Format `YYYY-MM-DD`.
' format: date examples: - '2022-12-25' effectiveDate: type: string description: 'Effective date of requested estimate
Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)
Format `YYYY-MM-DD`.
Field available in: Pro
' format: date examples: - '2022-12-25' propertyId: type: integer description: 'Unique identifier for a property
Field available in: Pro' examples: - 1234567 matchQuality: description: 'Defines the quality of the match returned
Refer to [Match Quality](https://developer.proptrack.com.au/docs/apis/guide#match-quality)Full address of the property
Field available in: Pro
' example: excellent enum: - excellent - good - ok estimatedValue: type: integer description: 'The SALE estimated value for the property
Field available in: Pro
' examples: - 785652 fsd: type: number format: float examples: - 0.39079999923706055 description: 'SALE forecast standard deviation of the AVM estimate.
Field available in: Pro' confidenceLevel: enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE description: 'The SALE confidence level, based on the FSD
Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)
Field available in: Pro
' upperRangeValue: type: integer examples: - 875250 description: 'The SALE upper range estimate of the AVM.
Field available in: Pro' lowerRangeValue: type: integer description: 'The SALE lower range estimate of the AVM
Field available in: Pro' examples: - 712352 rental: type: object description: Rental estimate properties: estimatedValue: type: integer description: 'The RENTAL weekly estimated value for the property
Field available in: Pro
' example: 650 fsd: type: number description: 'RENTAL forecast standard deviation of the AVM estimate.
Field available in: Pro' example: 0.0828 confidenceLevel: description: 'The RENTAL confidence level, based on the FSD
Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)
Field available in: Pro
' example: MEDIUM CONFIDENCE enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE lowerRangeValue: type: number description: 'The RENTAL upper range estimate of the AVM.
Field available in: Pro' example: 550 upperRangeValue: type: number description: 'The RENTAL lower range estimate of the AVM
Field available in: Pro' example: 850 lease: type: object description: The last Rental Listing details of the property properties: price: type: number description: The last listing price example: 850 duration: type: number description: period of listing in months, if provided example: 6 startDate: type: string description: 'Date of last lease start ' example: '2023-10-31' sourceType: description: source of lease example: listing enum: - listing - agency yield: type: object description: Rental Yield properties: yield: type: number example: 0.039 description: 'RENTAL Yield of the AVM estimate.
Field available in: Pro' fsd: type: number example: 0.121 description: 'RENTAL Yield forecast standard deviation of the AVM estimate.
Field available in: Pro' confidenceLevel: description: 'The RENTAL Yield confidence level, based on the FSD
Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)
Field available in: Pro
' example: MEDIUM CONFIDENCE enum: - HIGH CONFIDENCE - MEDIUM CONFIDENCE - LOW CONFIDENCE lowerRangeValue: type: number description: 'The RENTAL Yield lower range estimate of the AVM.
Field available in: Pro' upperRangeValue: type: number description: 'The RENTAL Yield Upper range estimate of the AVM
Field available in: Pro' usedAttributes: type: object description: 'The attributes used for the AVM valuation
Fields available in: Pro' properties: bedrooms: type: number description: 'Number of bedrooms
Field available in: Pro' examples: - 4 bathrooms: type: number description: 'Number of bathrooms
Field available in: Pro' examples: - 2 carSpaces: type: number description: 'Number of car spaces
Field available in: Pro' examples: - 2 propertyType: enum: - house - unit description: 'Classification of the type of property
Field available in: Pro' examples: - house type: string lat: type: number example: -35.31788658 description: 'Latitude (Lat) used as a target point ' lon: type: number example: 149.12432323 description: Longitude (Lon) used as a target point landUse: example: RESIDENTIAL description: Land Use classification of the property enum: - RESIDENTIAL - OTHER floorArea: type: number description: Floor space area (measured in m2) example: 87 livingArea: type: number example: 125 description: Living area (measured in m2), excluding Carspaces landArea: type: number example: 785 description: Land space area (measured in m2), not valid if Unit/Strata additionalInformation: type: object description: Optional supplementary information, only included if provided in the request payload. These fields are not required nor used in the valuation but may be used to enhance valuation context when supplied. properties: applicantEstimate: type: number description: 'Applicant''s estimated value of the property
Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)
Field available in: Pro
' customerReference: type: string description: 'Customer‑supplied reference identifier for tracking or reconciliation purposes
Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)
Field available in: Pro
' propertyRisks: type: object x-stoplight: id: wkme4lxno99iz description: Environmental hazards, include where property is subject to flood, fire or heritage overlays that may impact upon the property. Multiple data sources are available, plus discuss with your account manager for your needs. properties: bushfire: type: object x-stoplight: id: rzmn9tmczcgs2 properties: status: x-stoplight: id: 71se270w4e5xc description: If the property is subject to Bush fire. Base source values are 'true', 'false' & 'unknown" example: 'false' type: string flood: type: object x-stoplight: id: feo5gtuwe54o4 properties: status: type: string x-stoplight: id: qqbmakmbsgy6w description: If the property is subject to flood zone. Base source values are 'true', 'false' & 'unknown" example: 'false' flood_copy: type: object x-stoplight: id: xlgo34b8ulsi7 properties: status: type: string x-stoplight: id: b71c5y76060s4 description: If the property is subject to flood zone. Base source values are 'true', 'false' & 'unknown" example: 'false' heritageItem: type: object x-stoplight: id: ncwvcrt3pgdgr properties: status: type: string x-stoplight: id: v0jz6vc6oukjp description: 'If the property has a heritage overlay. Heritage overlays protect buildings, sites of architectural significance. Base source values are ''true'', ''false'' & ''unknown"' example: 'false' examples: AVM Pro Example: value: valuationId: 7ca6f369-5a3a-43cf-813e-b8fd3b10ad44 effectiveDate: '2025-01-05' valuationDate: '2026-02-04' propertyId: 2885938 estimatedValue: 1357053 fsd: 0.09 confidenceLevel: HIGH CONFIDENCE lowerRangeValue: 1230000 upperRangeValue: 1480000 rental: fsd: 0.0835 estimatedValue: 1008 confidenceLevel: HIGH CONFIDENCE lowerRangeValue: 920 upperRangeValue: 1090 lease: price: 800 duration: 6 startDate: '2022-03-04' sourceType: listing yield: fsd: 0.121 yield: 0.039 confidenceLevel: HIGH CONFIDENCE lowerRangeValue: 0.034 upperRangeValue: 0.044 propertyRisks: bushfire: status: 'false' flood: status: 'false' heritageItem: status: 'false' usedAttributes: lat: -38.02321285 lon: 145.10493289 landUse: RESIDENTIAL bedrooms: 4 landArea: 300.5 bathrooms: 5 carSpaces: 2 floorArea: 250.5 yearBuilt: 1999 livingArea: 541 propertyType: unit additionalInformation: loanAmount: 200000 applicantEstimate: 1579455 customerReference: RVT123 headers: Content-Type: schema: enum: - application/json type: string description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 400 errorLevel: CRITICAL errorMessage: 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - propertyId valid errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 400 description: Numeric value that defines the type of error that has occurred examples: - 400 type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' examples: - CRITICAL type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Bad Request: There was a problem with your request, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the parameter/s which is causing the error, and the rule that was invoked items: type: string examples: - 'Invalid Valuation ID: 29930cff-49ec-4ef5-83a6974d5e04300e' errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Numeric value that defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string description: type: string description: Briefly describes the type of error that has occured examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again examples: Example: value: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 403 errorLevel: CRITICAL errorMessage: 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' errorDetails: - string errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979" properties: errors: type: array items: type: object properties: errorCode: enum: - 9003 description: Defines the type of error that has occurred type: integer default: 9003 errorMessage: type: string description: Overview of the error that has occurred examples: - 'Forbidden: Access rights to the content is forbidden, check your input and ensure request contains the correct value. Please contact PropTrack Support if you require assistance' example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - errorCode - errorMessage examples: Example 403: value: errors: - errorCode: 9003 errorMessage: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 404 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - The path is incorrect, please adjust errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 examples: Example 1: value: errors: - errorCode: 404 errorLevel: CRITICAL errorMessage: 'Not Found: The path of this request is not valid, please check your endpoint and version. Please contact PropTrack Support if you require assistance' errorDetails: - The path is incorrect, please adjust errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly properties: errors: type: array items: type: object properties: code: type: integer description: Numeric value that defines the type of error that has occurred enum: - 9011 level: type: string description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' enum: - CRITICAL description: type: string example: Rate limit has been exceeded - Please try again shortly description: Briefly describes the type of error that has occured required: - code - level - description examples: Example 1: value: errors: - code: 9011 level: CRITICAL description: Rate limit has been exceeded - Please try again shortly '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - errorCode: 500 errorLevel: CRITICAL errorMessage: 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry but our internal server is not able to provide a response at this time errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 properties: errors: type: array items: type: object properties: errorCode: enum: - 500 description: Numeric value that defines the type of error that has occurred type: integer errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' type: string errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Internal Server Error: Sorry, due to an internal issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry but our internal server is not able to provide a response at this time errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 '504': description: ' > #### Gateway Timeout (504) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#avmsale) for information on error handling.' content: application/json: schema: type: object properties: errors: type: array items: type: object properties: errorCode: enum: - 504 description: Numeric value that defines the type of error that has occurred errorLevel: enum: - CRITICAL description: 'Defines the severity of the error - If level is `CRITICAL` then a successful response will not be returned' errorMessage: type: string description: Briefly describes the type of error that has occured examples: - 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: type: array description: Lists the rule that was invoked items: type: string examples: - Sorry the Realtime AVM is currently timing out errorId: type: string description: Unique identifier of the error format: uuid examples: - eab0ca7f-5a45-4f04-ad37-8e297661e979 x-examples: Example 1: errors: - errorCode: 504 errorLevel: CRITICAL errorMessage: 'Gateway Timeout: Sorry, due to an internal timeout issue we are unable to complete this request. Please contact PropTrack Support if you require assistance' errorDetails: - Sorry the Realtime AVM is currently timing out errorId: eab0ca7f-5a45-4f04-ad37-8e297661e979 servers: - url: https://data.proptrack.com x-stoplight: id: 07eml7x7btfop parameters: - schema: type: string name: propertyId in: path required: true /api/v2/properties/summaries/search: get: summary: /api/v2/properties/summaries/search tags: - Search parameters: - schema: type: string example: Bearer xxxxx in: header name: Authorization description: Provide your bearer token as a string, in the format Bearer {access_token} in the Authorization Header Refer to Authentication required: true - name: bedroomsMin in: query description: Minimum number of bedrooms schema: type: integer examples: - 3 - name: bedroomsMax in: query description: Maximum number of bedrooms schema: type: integer examples: - 4 - name: bathroomsMin in: query description: Minimum number of bathrooms schema: type: integer examples: - 1 - name: bathroomsMax in: query description: Maximum number of bathrooms schema: type: integer examples: - 3 - name: carSpacesMin in: query description: Minimum number of car spaces schema: type: integer examples: - 1 - name: carSpacesMax in: query description: Maximum number of car spaces schema: type: integer examples: - 2 - name: landAreaMin in: query description: Minimum size of land space area (measured in m2) schema: type: integer examples: - 550 - name: landAreaMax in: query description: Maximum size of land space area (measured in m2) schema: type: integer examples: - 650 - schema: type: integer in: query name: livingAreaMin description: Minimum size of living area (measured in m2) example: 300 - schema: type: integer in: query name: livingAreaMax description: Maximum size of living area (measured in m2) example: 850 - name: propertyType in: query description: Classification of the type of property schema: type: string enum: - house - unit example: house - name: afterPageCursor in: query description: 'The page starting position as one transaction after the defined cursor
Note: Cannot be used in conjunction with `beforePageCursor`
Refer to [Pagination](https://developer.proptrack.com.au/docs/apis/pagination)' schema: type: string example: Wzc3Ni4yMTQ2NjY0NTE4Mzk5LDM0Nzg0MDFd - name: beforePageCursor in: query description: 'The page starting position as one transaction prior to the defined cursor
Note: Cannot be used in conjunction with `afterPageCursor`
Refer to [Pagination](https://developer.proptrack.com.au/docs/apis/pagination)' schema: type: string example: WzU0LjgwNTYxNjE0MzQ5MTM4LDE0MDY5NjMzXQ== - name: pageSize in: query description: The maximum number of transaction results that will be returned for each page
Refer to [Pagination](https://developer.proptrack.com.au/docs/apis/pagination) schema: type: integer maximum: 25 default: 25 examples: - 20 example: 20 - schema: type: string example: -37.822170,144.945660,-37.807524,144.971410 in: query name: boundingBox description: 'Bounding box for map-based filtering. Must provide exactly 4 numbers.
Provided as comma separated values in the format `minLat`,`minLong`,`maxLat`,`maxLong`
Note: If `suburb`, `postcode` and `state` are not supplied, then this field is required' - schema: type: string in: query name: suburb description: 'Name of the suburb being searched
Note: If `boundingBox` is not supplied, then this field is required' - schema: type: string in: query name: postcode description: 'Postcode of the suburb being searched
Note: If `boundingBox` is not supplied, then this field is required' - schema: type: string enum: - act - nsw - nt - qld - sa - tas - vic - wa examples: - vic in: query name: state description: 'State or territory within Australia
Note: If `boundingBox` is not supplied, then this field is required' responses: '200': description: ' > #### Success (200)' content: application/json: schema: type: object properties: numberOfResults: type: integer description: Total number of transactions that match the search criteria
A maximum of 10,000 results will be returned for a query. examples: - 552 maximum: 10000 pageInfo: type: object description: Page information for the purpose of pagination
Refer to [Pagination](https://developer.proptrack.com.au/docs/apis/pagination) properties: pageStartCursor: type: - string - 'null' description: Unique cursor identifier for the first transaction on the page examples: - WzAuNTMxNTMzNzg3ODA4MDI2OCw3MTk5NDVd pageEndCursor: type: - string - 'null' description: Unique cursor identifier for the last transaction on the page examples: - LzRuPDMxNTMzNzg3OYF4MDI2OCw3MTk5NRAm hasPreviousPage: type: boolean description: Defines if a preceding page of transactions exists hasNextPage: type: boolean description: Defines if a proceeding page of transactions exists propertySummaries: type: array items: type: object x-stoplight: id: p36wtjcypqhf4 properties: propertyId: type: integer x-stoplight: id: q7xkn5piafan2 example: 8282053 address: type: - object - 'null' description: Property Address properties: fullAddress: type: string x-stoplight: id: 5zcjnr5bylbwx example: 12 Bowman Cl, Araluen, NT 0870 unitNumber: type: - string - 'null' x-stoplight: id: 9con9e51ism0o streetNumber: type: string x-stoplight: id: clbko5io646v2 example: '12' streetName: type: string x-stoplight: id: bw4tvscj30lip example: BOWMAN streetType: type: string x-stoplight: id: 5hlu0340u8gpp example: CL suburb: type: string x-stoplight: id: y963qnnh405jj example: ARALUEN postcode: type: string x-stoplight: id: uq3cgq7x70fo4 example: 0870 state: type: string x-stoplight: id: flar8wdlxumz6 example: NT location: type: object x-stoplight: id: 132d2f6rincwh properties: latitude: type: - number - 'null' x-stoplight: id: f8wfuuk7n91yk example: 133.85501 format: float longitude: type: - number - 'null' x-stoplight: id: zaalil8hrli8m example: -23.705948 format: float 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' lotNumber: type: - string - 'null' x-stoplight: id: tq7r5qvr3a6e7 example: '124' 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 sourceDate: type: string x-stoplight: id: muwf0padjmu3h example: '2022-12-10' bathrooms: type: - object - 'null' x-stoplight: id: xevadvjoh94ay properties: value: type: integer x-stoplight: id: swxxo7b3t5mb5 example: 2 sourceDate: type: string x-stoplight: id: 1ugflicke9iyp example: '2022-12-10' carSpaces: type: - object - 'null' x-stoplight: id: xsjmdm722qhd5 properties: value: type: integer x-stoplight: id: 3li5c1kkva2wp example: 1 sourceDate: type: string x-stoplight: id: wembyvpemf5o7 example: '2022-12-10' livingArea: type: - object - 'null' x-stoplight: id: 15pp9fi95kye2 properties: value: type: integer x-stoplight: id: ocuiz9j6z7027 example: 212 sourceDate: type: string x-stoplight: id: q3y3d06efheqo example: '2022-12-10' landArea: type: - object - 'null' x-stoplight: id: gthtn8avs8wa3 properties: value: type: integer x-stoplight: id: m30y4qhfnj76b example: 851 sourceDate: type: string x-stoplight: id: xqqywt8o9wvwv example: '2022-12-10' propertyType: type: - object - 'null' x-stoplight: id: z0t66hhmpp8wz properties: value: x-stoplight: id: grgym9ry9c8r6 example: house enum: - house - unit sourceDate: type: string x-stoplight: id: z8gu3rlabpvwj example: '2022-12-10' recentSale: x-stoplight: id: bzgjd39mjrswl type: - object - 'null' description: Provides recent (within the past 6 months) sale information for a given `propertyId`
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
\r\nFormat `YYYY-MM-DD`" 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
\r\nNote:\ \ suppressed transaction prices will be returned as undefined" saleValueSuppressed: type: boolean x-stoplight: id: lbyc1qn1xqquq 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.
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 extension: x-stoplight: id: nh7hr644wuhdy enum: - jpg - gif - png - pcx - svg - webp - ppm - tiff - nb example: jpg type: x-stoplight: id: fzuov6qm2la6r enum: - image - floorplan example: image sha: type: - string - 'null' x-stoplight: id: ijzdeupkgpgb6 example: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 activeListings: type: array x-stoplight: id: iy5usz8oixn50 description: "Provides an array of active rent or sale listings
\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
\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
\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 examples: Example 1: value: numberOfResults: 552 pageInfo: pageStartCursor: WzAuNTMxNTMzNzg3ODA4MDI2OCw3MTk5NDVd pageEndCursor: LzRuPDMxNTMzNzg3OYF4MDI2OCw3MTk5NRAm hasPreviousPage: true hasNextPage: true propertySummaries: - propertyId: 8282053 address: fullAddress: 12 Bowman Cl, Araluen, NT 0870 unitNumber: string streetNumber: '12' streetName: BOWMAN streetType: CL suburb: ARALUEN postcode: 0870 state: NT location: latitude: 133.85501 longitude: -23.705948 parcels: - planNumber: '786836' lotNumber: '124' attributes: bedrooms: value: 3 sourceDate: '2022-12-10' bathrooms: value: 2 sourceDate: '2022-12-10' carSpaces: value: 1 sourceDate: '2022-12-10' livingArea: value: 212 sourceDate: '2022-12-10' landArea: value: 851 sourceDate: '2022-12-10' propertyType: value: house sourceDate: '2022-12-10' recentSale: transactionDate: '2023-01-25' sourceCategory: vg saleValue: 1350000 saleValueSuppressed: true listingId: '7654321' image: id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg extension: jpg type: image sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4 activeListings: - listingId: '7654321' priceDescription: string listingType: sale marketStatus: - recentlySold headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 0 level: string description: string parameters: propertyId: string sourceCategory: string latestTransactionOnly: string properties: errors: type: array items: type: object properties: code: enum: - 7004 - 7007 - 7008 - 7011 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - An incorrect field type has been included - Please ensure that all values are using the correct field type parameters: type: object description: A set of parameters that are causing the error and the rule that was invoked properties: propertyId: type: string examples: - must be an integer sourceCategory: type: string examples: - must only include an allowed value latestTransactionOnly: type: string examples: - must be boolean required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9003 description: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint properties: errors: type: array items: type: object properties: code: type: integer enum: - 9003 description: Defines the type of error that has occurred description: type: string description: Overview of the error that has occurred example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - code - description '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 7002 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Unknown id, the included value does not match a record within our system - Please ensure that the correct value is added to this field required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9011 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Rate limit has been exceeded - Please try again shortly required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' operationId: get-api-v2-properties-summaries-search x-stoplight: id: ektnh73fbragv description: "Residential Properties search by suburb and postcode and/or bounding box, which returns\ \ paged property summaries (max 25 per page)
\r\nThis endpoint is ideal for property research,\ \ where the results are to be displayed in a list.\r\n\r\n#### Data Attribution Notice:\r\nThis\ \ endpoint contains State and Territory data which may be subject to approval by the relevant\ \ government department.\r\nDue to licensing agreement requirements, it is necessary to include\ \ data disclaimers and PropTrack branding when displaying this data in a user experience or printable\ \ output.\r\n

\r\nDisclaimer Types: `vg`,`geoscape`,`serviceAgent`\r\n\r\nPlease refer\ \ to [Disclaimers and Branding](https://developer.proptrack.com.au/docs/apis/disclaimersBranding)\ \ for more information on implementing data source disclaimers in your experience." parameters: [] /api/v2/properties/geopoints/search: get: summary: /api/v2/properties/geopoints/search tags: - Search parameters: - schema: type: string example: Bearer xxxxx in: header name: Authorization description: Provide your bearer token as a string, in the format Bearer {access_token} in the Authorization Header Refer to Authentication required: true - name: bedroomsMin in: query description: Minimum number of bedrooms schema: type: integer examples: - 3 - name: bedroomsMax in: query description: Maximum number of bedrooms schema: type: integer examples: - 4 - name: bathroomsMin in: query description: Minimum number of bathrooms schema: type: integer examples: - 1 - name: bathroomsMax in: query description: Maximum number of bathrooms schema: type: integer examples: - 3 - name: carSpacesMin in: query description: Minimum number of car spaces schema: type: integer examples: - 1 - name: carSpacesMax in: query description: Maximum number of car spaces schema: type: integer examples: - 2 - name: landAreaMin in: query description: Minimum size of land space area (measured in m2) schema: type: integer examples: - 550 - name: landAreaMax in: query description: Maximum size of land space area (measured in m2) schema: type: integer examples: - 650 - schema: type: integer in: query name: livingAreaMin description: Minimum size of living area (measured in m2) example: 300 - schema: type: integer in: query name: livingAreaMax description: Maximum size of living area (measured in m2) example: 850 - name: propertyType in: query description: Classification of the type of property schema: type: string enum: - house - unit example: house - name: afterPageCursor in: query description: 'The page starting position as one transaction after the defined cursor
Note: Cannot be used in conjunction with `beforePageCursor`
Refer to [Pagination](https://developer.proptrack.com.au/docs/apis/pagination)' schema: type: string example: Wzc3Ni4yMTQ2NjY0NTE4Mzk5LDM0Nzg0MDFd - name: beforePageCursor in: query description: 'The page starting position as one transaction prior to the defined cursor
Note: Cannot be used in conjunction with `afterPageCursor`
Refer to [Pagination](https://developer.proptrack.com.au/docs/apis/pagination)' schema: type: string example: WzU0LjgwNTYxNjE0MzQ5MTM4LDE0MDY5NjMzXQ== - name: pageSize in: query description: The maximum number of transaction results that will be returned for each page
Refer to [Pagination](https://developer.proptrack.com.au/docs/apis/pagination) schema: type: integer default: 25 examples: - 20 example: 20 maximum: 200 - schema: type: string example: -37.822170,144.945660,-37.807524,144.971410 in: query name: boundingBox description: 'Bounding box for map-based filtering.
Provided as comma separated values in the format `minLat`,`minLong`,`maxLat`,`maxLong`. Must provide exactly 4 numbers.
Note: If `suburb`, `postcode` and `state` are not supplied, then this field is required' - schema: type: string in: query name: suburb description: 'Name of the suburb being searched
Note: If `boundingBox` is not supplied, then this field is required' - schema: type: string in: query name: postcode description: 'Postcode of the suburb being searched
Note: If `boundingBox` is not supplied, then this field is required' - schema: type: string enum: - act - nsw - nt - qld - sa - tas - vic - wa examples: - vic in: query name: state description: 'State or territory within Australia
Note: If `boundingBox` is not supplied, then this field is required' responses: '200': description: ' > #### Success (200)' content: application/json: schema: type: object properties: numberOfResults: type: integer description: Total number of transactions that match the search criteria
A maximum of 10,000 results will be returned for a query. examples: - 552 maximum: 10000 pageInfo: type: object description: Page information for the purpose of pagination
Refer to [Pagination](https://developer.proptrack.com.au/docs/apis/pagination) properties: pageStartCursor: type: - string - 'null' description: Unique cursor identifier for the first transaction on the page examples: - WzAuNTMxNTMzNzg3ODA4MDI2OCw3MTk5NDVd pageEndCursor: type: - string - 'null' description: Unique cursor identifier for the last transaction on the page examples: - LzRuPDMxNTMzNzg3OYF4MDI2OCw3MTk5NRAm hasPreviousPage: type: boolean description: Defines if a preceding page of transactions exists hasNextPage: type: boolean description: Defines if a proceeding page of transactions exists propertyGeopoints: type: array description: Paged array of the geopoints for properties that match the search and filter criteria items: type: object x-stoplight: id: shiaa5vzsmnqx properties: propertyId: type: integer example: 8282053 address: type: object x-stoplight: id: usiq0hy89c8zd properties: location: type: object properties: latitude: type: number example: 133.85501 format: float longitude: type: number example: -23.705948 format: float examples: Example 1: value: numberOfResults: 552 pageInfo: pageStartCursor: WzAuNTMxNTMzNzg3ODA4MDI2OCw3MTk5NDVd pageEndCursor: LzRuPDMxNTMzNzg3OYF4MDI2OCw3MTk5NRAm hasPreviousPage: true hasNextPage: true propertyGeopoints: - propertyId: 8282053 address: location: latitude: 133.85501 longitude: -23.705948 headers: Content-Type: schema: type: string enum: - application/json description: Media type of the resource X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '400': description: ' > #### Bad Request (400) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 0 level: string description: string parameters: propertyId: string sourceCategory: string latestTransactionOnly: string properties: errors: type: array items: type: object properties: code: enum: - 7004 - 7007 - 7008 - 7011 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - An incorrect field type has been included - Please ensure that all values are using the correct field type parameters: type: object description: A set of parameters that are causing the error and the rule that was invoked properties: propertyId: type: string examples: - must be an integer sourceCategory: type: string examples: - must only include an allowed value latestTransactionOnly: type: string examples: - must be boolean required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '401': description: ' > #### Unauthorized (401) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9012 - 9016 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '403': description: ' > #### Forbidden (403) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9003 description: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint properties: errors: type: array items: type: object properties: code: type: integer enum: - 9003 description: Defines the type of error that has occurred description: type: string description: Overview of the error that has occurred example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint required: - code - description '404': description: ' > #### Not Found (404) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 7002 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Unknown id, the included value does not match a record within our system - Please ensure that the correct value is added to this field required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '429': description: ' > #### Too Many Requests (429) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' content: application/json: schema: type: object x-examples: Example 1: errors: - code: 9012 level: CRITICAL description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again properties: errors: type: array items: type: object properties: code: enum: - 9011 description: Defines the type of error that has occurred type: integer level: enum: - CRITICAL description: 'Defines the severity of the error
Note: If level is `CRITICAL` then a successful response will not be returned' x-deprecated: true type: string description: type: string description: Overview of the error that has occurred examples: - Rate limit has been exceeded - Please try again shortly required: - code - description headers: X-Transaction-Id: schema: type: string example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9 description: Should be quoted as a reference for any support request/unexpected error '500': description: ' > #### Internal Server Error (500) Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#propertiestransactions) for information on error handling.' operationId: get-api-v2-properties-geopoints-pins description: "Residential Properties search by suburb and postcode and/or bounding box, which returns\ \ lat/longs for each matching propertyI. (max 200 per page)
\r\nThis endpoint is ideal for\ \ property research, where the results are to be displayed as pins on a map.\r\n\r\nAdditional\ \ property information for individual properties can be retrieved from other PropTrack APIs utilising\ \ the provided propertyId.\r\n\r\n#### Data Attribution Notice:\r\nThis endpoint contains State\ \ and Territory data which may be subject to approval by the relevant government department.\r\ \nDue to licensing agreement requirements, it is necessary to include data disclaimers and PropTrack\ \ branding when displaying this data in a user experience or printable output.\r\n

\r\n\ Disclaimer Types: `vg`,`geoscape`,`serviceAgent`\r\n\r\nPlease refer to [Disclaimers and Branding](https://developer.proptrack.com.au/docs/apis/disclaimersBranding)\ \ for more information on implementing data source disclaimers in your experience.\r\n" x-stoplight: id: cku33zeq67ty6 parameters: [] tags: - name: Attributes description: Property Attributes - name: AVM description: AVM - name: Listings description: Property Listings - name: Planning description: Property Planning Overlays - name: Search description: Property Search - name: Summary description: Property Summary - name: Tenure Type description: Property Tenure Type History - name: Transactions description: Property Transactions