openapi: 3.2.0
info:
  version: '1.0'
  title: Properties AVM API
  description: "<div class=\"cta\" style=\"display: flex; justify-content: flex-start; flex-wrap: wrap; margin-top: 0px; margin-bottom: 30px\">\n  <div\n      style=\"\n        text-align: left;\n        min-width: 1000px;\n        font-family: 'Open Sans', Arial, sans-serif;\n        padding: 13px 20px;\n        color: rgb(255, 255, 255);\n        font-size: 16px;\n        line-height: 28px;\n        font-weight: 700;\n        border-radius: 4px;\n        background: #0078BD;\n        text-decoration: none;\n        margin-right: 20px;\n        margin-top: 10px;\n      \"\n      ><i class=\"fa-solid fa-house\"></i> &nbsp; &nbsp;Properties API</div\n    >\n\n- **[Properties/Summary](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-2-property-summary): <span style=\"color:#28a745;\">**GET**</span> /api/v2/properties/{propertyId}/summary**</br>Retrieves basic property and listing information about a property, including a single photo and current market status </br>\n- **[Properties/Attributes](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-attributes): <span style=\"color:#28a745;\">**GET**</span> /api/v2/properties/{propertyId}/attributes**</br>Retrieves comprehensive and up to date property attributes and features for a given property </br>\n- **[Properties/Listings](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-listings): <span style=\"color:#28a745;\">**GET**</span> /api/v2/properties/{propertyId}/listings**</br>Retrieves current and historic listings for a given property.</br>\n- **[Properties/Planning:](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-planning) <span style=\"color:#28a745;\">**GET**</span> /api/v2/properties/{propertyId}/planning**</br>Retrieves planning and zoning information for a given property</br>\n- **[Properties/TenureType:](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-tenure-type) <span style=\"color:#28a745;\">**GET**</span> /api/v2/properties/{propertyId}/tenure-type**</br>Retrieves historical property tenure information for a given property</br>\n- **[Properties/Transactions:](https://developer.proptrack.com.au/docs/apis/properties/operations/list-api-v-2-property-transactions) <span style=\"color:#28a745;\">**GET**</span> /api/v2/properties/{propertyId}/transactions**</br>Retrieves sold transactions for a given property</br>\n\n<div class=\"cta\" style=\"display: flex; justify-content: flex-start; flex-wrap: wrap; margin-top: 0px; margin-bottom: 30px\">\n  <div\n      style=\"\n        text-align: left;\n        min-width: 1000px;\n        font-family: 'Open Sans', Arial, sans-serif;\n        padding: 13px 20px;\n        color: rgb(255, 255, 255);\n        font-size: 16px;\n        line-height: 28px;\n        font-weight: 700;\n        border-radius: 4px;\n        background: #0078BD;\n        text-decoration: none;\n        margin-right: 20px;\n        margin-top: 10px;\n      \"\n      ><i class=\"fa-solid fa-money-bill-wave\"></i> &nbsp; &nbsp;AVM Valuation API</div\n    >\n\n \n- **[Properties/Valuations/Sale](https://developer.proptrack.com.au/docs/apis/properties/operations/create-a-api-v-1-property-valuation-sale): <span style=\"color:#28a745;\">**Post**</span> /api/v1/properties/valuations/sale**</br> Orders a sale valuation from PropTrack's Automated Valuation Model (AVM) for a given address string, either as requestType=enquiry OR requestType=origination</br>\n- **[Properties/Valuations/Sale](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-sale-request-type-enquiry-or-request-type-origination): <span style=\"color:#28a745;\">**GET**</span> /api/v1/properties/{propertyId}/valuations/sale**</br> Orders a sale valuation from PropTrack's Automated Valuation Model (AVM) for a given property (by propertyId), , either as ?requestType=enquiry OR ?requestType=origination</br>\n- **[Properties/Valuations/Rent](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-rent-request-type-enquiry-or-request-type-origination): <span style=\"color:#28a745;\">**GET**</span> /api/v1/properties/{propertyId}/valuations/rent?requestType=enquiry OR requestType-origination**</br> Orders an Enquiry Rental valuation from PropTrack's Automated Valuation Model (AVM) for a given property (by propertyId), either as Enquiry or Origination Request Type</br>\n- **[Properties/Valuations/Sale~AVM Plus](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-sale-request-type-plus): <span style=\"color:#28a745;\">**Post**</span> /api/v1/properties/valuations/sale ~plus**</br> Orders a AVM Plus valuation from PropTrack's Automated Valuation Model (AVM) for a given address string, combines Sale and Rental into a single request</br>\n- **[Properties/Valuations/Sale~AVM Plus](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-sale-request-type-plus): <span style=\"color:#28a745;\">**GET**</span> /api/v1/properties/{propertyId}/valuations/sale?requestType=plus**</br> Orders a AVM Plus valuation from PropTrack's Automated Valuation Model (AVM) for a given property (by propertyId), combines Sale and Rental into a single request</br>\n- **[Properties/Valuations/Sale~AVM Pro](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-sale-request-type-pro): <span style=\"color:#28a745;\">**Post**</span> /api/v1/properties/valuations/sale ~pro**</br> Orders a AVM Pro valuation from PropTrack's Automated Valuation Model (AVM) for a given address string, combines Sale, Rental and environment hazards into a single request</br>\n- **[Properties/Valuations/Sale~AVM Pro](https://developer.proptrack.com.au/docs/apis/properties/operations/get-a-api-v-1-property-valuation-sale-request-type-pro): <span style=\"color:#28a745;\">**GET**</span> /api/v1/properties/{propertyId}/valuations/sale?requestType=pro**</br> Orders a AVM Pro valuation from PropTrack's Automated Valuation Model (AVM) for a given property (by propertyId), combines Sale, Rental and environment hazards into a single request</br>\n\n\n\n</br>\n\n<div class=\"section-about\" style=\"margin-top: 40px\">\n  <div class=\"page-section__inner\" style=\"margin: 0px auto; max-width: 1250px; -webkit-font-smoothing: antialiased\"  >\n    <div\n      class=\"cards-list\"\n      style=\"\n        display: flex;\n        flex-wrap: wrap;\n        justify-content: space-between;\n        margin: 20px 0px;\n        max-width: 900px;\n        padding: px;\n        box-sizing: 1px;\n        border-box: 1px;\n        border-color: black;\n      \"\n    >\n      <div\n        class=\"cards-list__item\"\n        style=\"\n          margin-top: 16px;\n          padding: 0px 16px;\n          max-width: 250px;\n          min-width: 200px;\n          margin-bottom: 0px;\n          box-sizing: border-box;\n        \"\n      >\n        <div\n          class=\"card__thumb\"\n          style=\"height: 49px; width: 50px; background-color: #0078BD; border-radius: 4px; padding: 4px; display: flex; align-items: center; justify-content: center;\"\n        >\n          <i class=\"fa-regular fa-badge-check\" style=\"font-size: 24px; color: #F7F8F9;\"></i>\n        </div>\n        <div\n          class=\"card__title\"\n          style=\"\n            margin-top: 22px;\n            font-family: Graphik, Arial, sans-serif;\n            font-size: 24px;\n            line-height: 36px;\n            font-weight: 700;\n            color: rgb(44, 44, 44);\n          \"\n        >\n          Getting Started\n        </div>\n        <div\n          class=\"card__text\"\n          style=\"\n            margin-top: 8px;\n            font-size: 14px;\n            line-height: 24px;\n            font-family: 'Open Sans', Arial, sans-serif;\n            font-weight: 400;\n            color: rgb(44, 44, 44);\n          \"\n        >\n           Start your journey\n        </div>\n        <ul>\n          <li>\n            <a href=\"https://developer.proptrack.com.au/docs/apis/api-trials\"\n              > API Trials</a\n            >\n          </li>\n          <li><a href=\"https://developer.proptrack.com.au/docs/apis/how-to-authenticate\">Authentication</a></li>\n          <li>\n            <a href=\"https://developer.proptrack.com.au/docs/apis/error-handling\">Error Handling</b></a>\n          </li>\n        </ul>\n      </div>\n      <div\n        class=\"cards-list__item\"\n        style=\"\n          margin-top: 16px;\n          padding: 0px 16px;\n          max-width: 250px;\n          min-width: 200px;\n          margin-bottom: 0px;\n          box-sizing: border-box;\n        \"\n      >\n        <div\n          class=\"card__thumb\"\n          style=\"height: 49px; width: 50px; background-color: #0078BD; border-radius: 4px; padding: 4px; display: flex; align-items: center; justify-content: center;\"\n        >\n          <i class=\"fa-regular fa-list\" style=\"font-size: 24px; color: #F7F8F9;\"></i>\n        </div>\n        <div\n          class=\"card__title\"\n          style=\"\n            margin-top: 22px;\n            font-family: Graphik, Arial, sans-serif;\n            font-size: 24px;\n            line-height: 36px;\n            font-weight: 700;\n            color: rgb(44, 44, 44);\n          \"\n        >\n          API References\n        </div>\n        <div\n          class=\"card__text\"\n          style=\"\n            margin-top: 8px;\n            font-size: 14px;\n            line-height: 24px;\n            font-family: 'Open Sans', Arial, sans-serif;\n            font-weight: 400;\n            color: rgb(44, 44, 44);\n          \"\n        >\n          Explore our knowledge base\n        </div>\n        <ul>\n          <li>\n            <a href=\"https://developer.proptrack.com.au/docs/apis/guide\"\n              >API Guide</a\n            >\n          </li>\n          <li><a href=\"https://developer.proptrack.com.au/docs/apis/rate-limits\">Rate Limiting</a></li>\n          <li>\n            <a href=\"https://developer.proptrack.com.au/docs/apis/getting-support\"\n              >Getting Support</a\n            >\n          </li>\n        </ul>\n      </div>\n      <div\n        class=\"cards-list__item\"\n        style=\"\n          margin-top: 16px;\n          padding: 0px 16px;\n          max-width: 250px;\n          min-width: 200px;\n          margin-bottom: 0px;\n          box-sizing: border-box;\n        \"\n      >\n        <div\n          class=\"card__thumb\"\n          style=\"height: 49px; width: 50px; background-color: #0078BD; border-radius: 4px; padding: 4px; display: flex; align-items: center; justify-content: center;\"\n        >\n          <i class=\"fa-regular fa-files\" style=\"font-size: 24px; color: #F7F8F9;\"></i>\n        </div>\n        <div\n          class=\"card__title\"\n          style=\"\n            margin-top: 22px;\n            font-family: Graphik, Arial, sans-serif;\n            font-size: 24px;\n            line-height: 36px;\n            font-weight: 700;\n            color: rgb(44, 44, 44);\n          \"\n        >\n          Useful Docs\n        </div>\n        <div\n          class=\"card__text\"\n          style=\"\n            margin-top: 8px;\n            font-size: 14px;\n            line-height: 24px;\n            font-family: 'Open Sans', Arial, sans-serif;\n            font-weight: 400;\n            color: rgb(44, 44, 44);\n          \"\n        >\n          Helpful resources\n        </div>\n        <ul>\n          <li>\n            <a href=\"https://developer.proptrack.com.au/docs/apis/pagination\">Pagination</a>\n          </li>\n          <li><a href=\"https://developer.proptrack.com.au/docs/apis/rules-engine\">Rules Engine</a></li>\n          <li><a href=\"https://developer.proptrack.com.au/docs/apis/faqs\">FAQs</a></li>\n        </ul>\n      </div>\n      <div\n        class=\"cards-list__item\"\n        style=\"\n          margin-top: 16px;\n          padding: 0px 16px;\n          max-width: 250px;\n          min-width: 200px;\n          margin-bottom: 0px;\n          box-sizing: border-box;\n        \"\n      >\n        <div\n          class=\"card__thumb\"\n          style=\"height: 49px; width: 50px; background-color: #0078BD; border-radius: 4px; padding: 4px; display: flex; align-items: center; justify-content: center;\"\n        >\n          <i class=\"fa-regular fa-tag\" style=\"font-size: 24px; color: #F7F8F9;\"></i></i>\n        </div>\n        <div\n          class=\"card__title\"\n          style=\"\n            margin-top: 22px;\n            font-family: Graphik, Arial, sans-serif;\n            font-size: 24px;\n            line-height: 36px;\n            font-weight: 700;\n            color: rgb(44, 44, 44);\n          \"\n        >\n          Get in Touch\n        </div>\n        <div\n          class=\"card__text\"\n          style=\"\n            margin-top: 8px;\n            font-size: 14px;\n            line-height: 24px;\n            font-family: 'Open Sans', Arial, sans-serif;\n            font-weight: 400;\n            color: rgb(44, 44, 44);\n          \"\n        >\n          Connect with us\n        </div>\n        <ul>\n          <li><a href=\"https://www.proptrack.com.au/contact-us/sales/\">Contact Sales</a></li>\n          <li><a href=\"https://www.proptrack.com.au/support/contact-support/\">Contact Support</a></li>\n        </ul>\n      </div>\n    </div>\n  </div>\n</div>"
  contact:
    email: support@proptrack.com
    name: PropTrack Support
servers:
- url: https://data.proptrack.com
  description: ''
tags:
- name: AVM
  description: AVM
paths:
  /api/v1/properties/valuations/sale:
    parameters: []
    post:
      tags:
      - AVM
      summary: /api/v1/properties/valuations/sale ~ Enquiry or Origination
      description: "<span style=\"color:#0078BD;\">**AVM Sale - by address:**</span> 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 <span style=\"color:#0078BD;\">fullAddress OR address</span>, only provide either not both in the same request.\n\nThis operation supports two <span style=\"color:#0078BD;\">requestType</span> 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- <p style=\"color:#0078BD\"><b>Enquiry:</B></p> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=enquiry</span></span> </p> a simplified version only returning the property valuation details \n ![Sale_Enquiry](../assets/images/AVM-origination.png)\n- <p style=\"color:#0078BD\"><b>Origination:</B></p> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=origination</span></span> </p> 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</br>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 <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: lite-bold;">requestType</span>, for the <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: lite-bold;">sale</span> estimates, each type is operated by unique <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: lite-bold;">requestType</span> in the body:


          - <p style="color:#0078BD"><b>Enquiry:</B></p> <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">requestType=enquiry</span></span> </p>will service your basic AVM needs by providing all fields you will find our PropTrackpowered experiences


          - <p style="color:#0078BD"><b>Origination:</B></p> <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">requestType=origination</span></span> </p> 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 - <p style=\"color:#0078BD\"><b>Enquiry:</p> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=enquiry</span></span> </b>will service your basic AVM needs by providing all fields you will find our PropTrackpowered experiences\n - <p style=\"color:#0078BD\"><b>Origination:</p> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=origination</span></span> </b>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<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                    '
                  examples:
                  - 1/67 Louisa Rd, Birchgrove, NSW 2041
                address:
                  type: object
                  description: 'Structured address of the property, either fullAddress or address not both allowed<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                    '
                  properties:
                    lotNumber:
                      type: string
                      description: 'Lot number of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                        '
                      examples:
                      - Lot 123
                    unitNumber:
                      type: string
                      description: 'Unit number of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                        '
                      examples:
                      - Unit 1
                    streetNumber:
                      type: string
                      description: 'Street number of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                        '
                      examples:
                      - '67'
                    streetName:
                      type: string
                      description: 'Street name of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                        '
                      examples:
                      - Louisa
                    streetType:
                      type: string
                      description: 'Street type of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                        '
                      examples:
                      - Rd
                    suburb:
                      type: string
                      description: 'Suburb of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                        '
                      examples:
                      - Birchgrove
                    state:
                      type: string
                      description: 'State of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                        '
                      examples:
                      - NSW
                    postCode:
                      type: string
                      description: 'Postcode of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                        '
                      examples:
                      - '2041'
                effectiveDate:
                  type: string
                  description: 'Effective date of requested estimate</br>Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)</br>Format `YYYY-MM-DD` <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                  format: date
                  examples:
                  - '2022-06-30'
                updatedAttributes:
                  type: object
                  description: 'Customer supplied attributes</br>Refer to [Updated Attributes](https://developer.proptrack.com.au/docs/apis/guide#updated-attributes)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                  properties:
                    bedrooms:
                      type: integer
                      description: 'Number of bedrooms<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                      examples:
                      - 4
                    bathrooms:
                      type: integer
                      description: 'Number of bathrooms<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                      examples:
                      - 2
                    carSpaces:
                      type: integer
                      description: 'Number of car spaces<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                      examples:
                      - 2
                    propertyType:
                      enum:
                      - house
                      - unit
                      description: 'Classification of the type of property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                      type: string
                    landArea:
                      type: integer
                      description: 'Land space area (measured in m2)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                      examples:
                      - 605
                    floorArea:
                      type: integer
                      description: 'Floor space area (measured in m2)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                      examples:
                      - 322
                additionalInformation:
                  type: object
                  properties:
                    applicantEstimate:
                      type: integer
                      description: 'Applicant''s estimated value of the property</br>Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                      examples:
                      - 1030000
                    loanAmount:
                      type: integer
                      description: 'Outstanding loan amount on the property</br>Refer to [Loan Amount](https://developer.proptrack.com.au/docs/apis/guide#loan-amount)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                      examples:
                      - 850000
                    customerReference:
                      type: string
                      description: 'Customer Reference Key</br>Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                      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: "<!-- theme: success -->\n\n> #### Success (200)\n\nBased on the <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=?</span></span> 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\nAn AVM Sale Report can be generated for <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=origination</span></span>for using the returned <span style=\"color:#0078BD;\">**valuationId**</span>. Simply pass the <span style=\"color:#0078BD;\">**valuationId**</span> value into the GET AVM Report endpoint to retrieve a professionally formatted report. For implementation details, refer to the <a href=\"https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-pdf\">GET AVM Report</a>.\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.</br>This can be used to <a href="https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-sale-pdf">Generate a Report</a><br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                    format: uuid
                    examples:
                    - 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2
                  valuationDate:
                    type: string
                    description: 'Date of the AVM valuation </br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span> <br>Format `YYYY-MM-DD`. </br>'
                    format: date
                    examples:
                    - '2022-05-22'
                  effectiveDate:
                    type: string
                    format: date
                    examples:
                    - '2022-05-22'
                    description: 'Effective date of requested estimate</br>Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date) </br>Format `YYYY-MM-DD`. </br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                  fullAddress:
                    type: string
                    description: 'Full address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                    examples:
                    - 1/67 Louisa Rd, Birchgrove, NSW 2041
                  address:
                    type: object
                    description: 'the Structured address of the property, optional extra to the fullAddress<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                    properties:
                      lotNumber:
                        type: string
                        description: 'Lot number of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - Lot 123
                      unitNumber:
                        type: string
                        description: 'Unit number of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - Unit 1
                      streetNumber:
                        type: string
                        description: 'Street number of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - '67'
                      streetName:
                        type: string
                        description: 'Street name of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - Louisa
                      streetType:
                        type: string
                        description: 'Street type of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - Rd
                      suburb:
                        type: string
                        description: 'Suburb of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - Birchgrove
                      state:
                        type: string
                        description: 'State of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - NSW
                      postCode:
                        type: string
                        description: 'Postcode of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - '2041'
                  matchQuality:
                    enum:
                    - EXCELLENT
                    - GOOD
                    - OK
                    - POOR
                    description: 'Defines the quality of the match returned</br>Refer to [Match Quality](https://developer.proptrack.com.au/docs/apis/guide#match-quality)Full address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                    examples:
                    - EXCELLENT
                    type: string
                  estimatedValue:
                    type: integer
                    description: 'The estimated value for the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                    examples:
                    - 785652
                  fsd:
                    type: number
                    description: 'Forecast standard deviation of the AVM estimate<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                    format: float
                    examples:
                    - 0.13907999992370604
                  upperRangeValue:
                    type: integer
                    description: 'The upper range estimate of the AVM<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                      '
                    examples:
                    - 875625
                  lowerRangeValue:
                    type: number
                    description: 'The lower range estimate of the AVM<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                      '
                    examples:
                    - 654123
                  confidenceLevel:
                    enum:
                    - HIGH CONFIDENCE
                    - MEDIUM CONFIDENCE
                    - LOW CONFIDENCE
                    description: 'The confidence level, based on the FSD</br>Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>

                      '
                    examples:
                    - HIGH CONFIDENCE
                    type: string
                  usedAttributes:
                    type: object
                    description: 'The attributes used for the AVM valuation</br>Refer to [Updated Attributes](https://developer.proptrack.com.au/docs/apis/guide#updated-attributes)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                    properties:
                      bedrooms:
                        type: integer
                        description: 'Number of bedrooms<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - 4
                      bathrooms:
                        type: integer
                        description: 'Number of bathrooms<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - 2
                      carSpaces:
                        type: integer
                        description: 'Number of car spaces<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - 2
                      propertyType:
                        enum:
                        - house
                        - unit
                        description: 'Classification of the type of property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        type: string
                      landArea:
                        type: integer
                        description: 'Land space area (measured in m2)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - 605
                      floorArea:
                        type: integer
                        description: 'Floor space area (measured in m2)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        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</br>Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - 1030000
                      loanAmount:
                        type: integer
                        description: 'Outstanding loan amount on the property, if included in the request</br>Refer to [Loan Amount](https://developer.proptrack.com.au/docs/apis/guide#loan-amount)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        examples:
                        - 850000
                      customerReference:
                        type: string
                        description: 'Customer Reference Key, if included in the request</br>Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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 <br>

                            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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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
  /api/v1/properties/{propertyId}/valuations/sale?requestType=enquiry or requestType=origination:
    parameters:
    - schema:
        type: string
      name: propertyId
      in: path
      required: true
    get:
      tags:
      - AVM
      summary: /api/v1/properties/{propertyId}/valuations/sale?requestType=enquiry or requestType=origination
      description: "<span style=\"color:#0078BD;\">**AVM Sale - by propertyId:**</span>Get a property price estimate from PropTrack’s Sale Automated Valuation Model (AVM) using a propertyId. \n\nThe service returns the most up-to-date value estimate for the specified <span style=\"color:#0078BD;\">propertyId</span>.\n\nThis operation supports two <span style=\"color:#0078BD;\">requestType</span> options for <span style=\"color:#0078BD;\">propertyId</span> based estimates. Each type uses its own parameters, and customers can be enabled for one or both:\n\n\n- <p style=\"color:#0078BD\"><b>Enquiry:</B></p> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=enquiry</span></span> </p> a simplified version only returning the property valuation details \n ![Sale_Enquiry](../assets/images/AVM-origination.png)\n- <p style=\"color:#0078BD\"><b>Origination:</B></p> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=origination</span></span> </p> 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</br>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</br>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    - <p style="color:#0078BD"><b>Enquiry:</p> <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">requestType=enquiry</span></span> </b>will service your basic AVM needs by providing all fields you will find our PropTrackpowered experiences  - <p style="color:#0078BD"><b>Origination:</p> <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">requestType=origination</span></span> </b>offers a more detailed view of what goes into the price estimate including attributes, comparable properties and other details'
      requestBody:
        content: {}
      responses:
        '200':
          description: "<!-- theme: success -->\n\n> #### Success (200)\n\n\nBased on the <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=?</span></span> 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\nAn AVM Sale Report can be generated for <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=origination</span></span>for using the returned <span style=\"color:#0078BD;\">**valuationId**</span>. Simply pass the <span style=\"color:#0078BD;\">**valuationId**</span> value into the GET AVM Report endpoint to retrieve a professionally formatted report. For implementation details, refer to the <a href=\"https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-pdf\">GET AVM Report</a>.\n"
          content:
            application/json:
              schema:
                type: object
                properties:
                  valuationId:
                    type: string
                    description: 'Unique identifier for an AVM valuation.</br>This can be used to <a href="https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-sale-pdf">Generate a Report</a><br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                    examples:
                    - 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2
                  valuationDate:
                    type: string
                    description: 'Date of the AVM valuation </br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span> <br>Format `YYYY-MM-DD`. </br>'
                    format: date
                    examples:
                    - '2022-12-25'
                  effectiveDate:
                    type: string
                    description: 'Effective date of requested estimate</br>Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date) </br>Format `YYYY-MM-DD`. </br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                    format: date
                    examples:
                    - '2022-12-25'
                  propertyId:
                    type: integer
                    description: 'Unique identifier for a property</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span>'
                    examples:
                    - 1234567
                  estimatedValue:
                    type: integer
                    description: 'The estimated value for the property</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                    examples:
                    - 785652
                  fsd:
                    type: number
                    format: float
                    examples:
                    - 0.39079999923706055
                    description: 'Forecast standard deviation of the AVM estimate. </br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span>'
                  confidenceLevel:
                    x-stoplight:
                      id: 878cx4dblu0i0
                    enum:
                    - HIGH CONFIDENCE
                    - MEDIUM CONFIDENCE
                    - LOW CONFIDENCE
                    description: 'The confidence level, based on the FSD</br>Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                  upperRangeValue:
                    type: integer
                    examples:
                    - 875250
                    description: 'The upper range estimate of the AVM.</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span>'
                  lowerRangeValue:
                    type: integer
                    description: 'The lower range estimate of the AVM</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span>'
                    examples:
                    - 712352
                  usedAttributes:
                    type: object
                    description: 'The attributes used for the AVM valuation</br> Fields available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span>'
                    properties:
                      bedrooms:
                        type: integer
                        description: 'Number of bedrooms</br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span>'
                        examples:
                        - 4
                      bathrooms:
                        type: integer
                        description: 'Number of bathrooms</br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span>'
                        examples:
                        - 2
                      carSpaces:
                        type: integer
                        description: 'Number of car spaces</br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span>'
                        examples:
                        - 2
                      propertyType:
                        enum:
                        - house
                        - unit
                        description: 'Classification of the type of property</br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span>'
                        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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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 <br>

                            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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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
  /api/v1/properties/{propertyId}/valuations/rent?requestType=enquiry or requestType=origination:
    parameters:
    - schema:
        type: string
      name: propertyId
      in: path
      required: true
      description: Property Id from address match/suggest
    get:
      summary: /api/v1/properties/{propertyId}/valuations/rent?requestType=enquiry or requestType=origination
      tags:
      - AVM
      responses:
        '200':
          description: "<!-- theme: success -->\n\n> #### Success (200)\n\n\nBased on the <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=?</span></span> 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\nAn AVM Rental Report can be generated for <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=origination</span></span>for using the returned <span style=\"color:#0078BD;\">**valuationId**</span>. Simply pass the <span style=\"color:#0078BD;\">**valuationId**</span> value into the GET AVM Report endpoint to retrieve a professionally formatted report. For implementation details, refer to the <a href=\"https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-pdf\">GET AVM Report</a>.\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</br>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)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span></span><br>'
                    example: 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2
                  valuationDate:
                    type:
                    - string
                    example: '2024-12-01'
                    format: date
                    description: 'Date of the AVM valuation</br>Format `YYYY-MM-DD` <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span></span><br>'
                  effectiveDate:
                    type: string
                    format: date
                    example: '2024-12-01'
                    description: 'Effective date of requested estimate</br>Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)</br>Format `YYYY-MM-DD` <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span></span><br>'
                  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<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br> '
                      lowerRangeValue:
                        type: number
                        example: 450
                        x-stoplight:
                          id: x6kd8satsslk1
                      upperRangeValue:
                        type: number
                        description: 'The weekly rental upper range of the AVM<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        example: 750
                        x-stoplight:
                          id: newnf1xm6r60f
                      confidenceLevel:
                        x-stoplight:
                          id: dliw7yx7o6t83
                        description: 'Rental confidence level<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Enquiry</span>, <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Origination</span></span><br>'
                        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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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 <br>

                            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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: "<span style=\"color:#0078BD;\">**AVM Rental - by propertyId:**</span>Get a Rental estimate from Proptrack’s Rental Automated Valuation Model (AVM).\n\nJust provide the  <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: lite-bold;\">propertyId</span> to get the most up-to-date rental estimate.\n\nWe offer two distinct <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: lite-bold;\">requestType</span>, for the <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: lite-bold;\">rent</span> estimates, each type is operated by unique query parameters:\n\n\n- <p style=\"color:#0078BD\"><b>Enquiry:</B></p> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=enquiry</span></span> </p> a simplified version only returning the property valuation details... \n ![Rental_Enquiry](../assets/images/enquiry-rent.png)\n- <p style=\"color:#0078BD\"><b>Origination:</B></p> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=origination</span></span> </p> 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</br>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
  /api/v1/properties/valuations/sale ~ requestType=plus:
    parameters: []
    post:
      tags:
      - AVM
      summary: /api/v1/properties/valuations/sale ~ Plus
      description: "<span style=\"color:#0078BD;\">**AVM Plus - by address:**</span> 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 <span style=\"color:#0078BD;\">**fullAddress or address**</span> , you can retrieve the latest and most accurate valuation available, enabling faster decisions and seamless integration into your business workflows.\n\n\n\n- <p style=\"color:#0078BD\"><b>Plus</B></p> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=plus</span></span> </p> 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<span style=\"color:#0078BD\"><b>Note:</B></span> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=plus</span></span> 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</br>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 <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: lite-bold;">requestType=plus</span>, will generate the <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: lite-bold;">AVM Plus</span> response containing both Sales and Rental data in the same endpoint<span style="background-color: #f5f5f5; padding: 0.2em; font-weight: lite-bold;">requestType</span> 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<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                    '
                  examples:
                  - 1/67 Louisa Rd, Birchgrove, NSW 2041
                address:
                  type: object
                  description: 'Structured address of the property, either fullAddress or address not both allowed<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                    '
                  properties:
                    lotNumber:
                      type: string
                      description: 'Lot number of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>

                        '
                      examples:
                      - Lot 123
                    unitNumber:
                      type: string
                      description: 'Unit number of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                        '
                      examples:
                      - Unit 1
                    streetNumber:
                      type: string
                      description: 'Street number of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                        '
                      examples:
                      - '67'
                    streetName:
                      type: string
                      description: 'Street name of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                        '
                      examples:
                      - Louisa
                    streetType:
                      type: string
                      description: 'Street type of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                        '
                      examples:
                      - Rd
                    suburb:
                      type: string
                      description: 'Suburb of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                        '
                      examples:
                      - Birchgrove
                    state:
                      type: string
                      description: 'State of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                        '
                      examples:
                      - NSW
                    postCode:
                      type: string
                      description: 'Postcode of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                        '
                      examples:
                      - '2041'
                effectiveDate:
                  type: string
                  description: 'Effective date of requested estimate</br>Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)</br>Format `YYYY-MM-DD` <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                  format: date
                  examples:
                  - '2022-06-30'
                  example: '2026-02-28'
                updatedAttributes:
                  type: object
                  description: 'Customer supplied attributes</br>Refer to [Updated Attributes](https://developer.proptrack.com.au/docs/apis/guide#updated-attributes)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                  properties:
                    bedrooms:
                      type: integer
                      description: 'Number of bedrooms<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                      examples:
                      - 4
                    bathrooms:
                      type: integer
                      description: 'Number of bathrooms<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                      examples:
                      - 2
                    carSpaces:
                      type: integer
                      description: 'Number of car spaces<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                      examples:
                      - 2
                    propertyType:
                      enum:
                      - house
                      - unit
                      description: 'Classification of the type of property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                      type: string
                    landArea:
                      type: integer
                      description: 'Land space area (measured in m2)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                      examples:
                      - 605
                    floorArea:
                      type: integer
                      description: 'Floor space area (measured in m2)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                      examples:
                      - 322
                additionalInformation:
                  type: object
                  properties:
                    applicantEstimate:
                      type: integer
                      description: 'Applicant''s estimated value of the property</br>Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                      examples:
                      - 1030000
                    loanAmount:
                      type: integer
                      description: 'Outstanding loan amount on the property</br>Refer to [Loan Amount](https://developer.proptrack.com.au/docs/apis/guide#loan-amount)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                      examples:
                      - 850000
                    customerReference:
                      type: string
                      description: 'Customer Reference Key</br>Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                      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: '<!-- theme: success -->


            > #### Success (200)

            Response delivers comprehensive Sale and Rental data to support informed property insights.


            An AVM Plus Report can be generated using the returned <span style="color:#0078BD;">**valuationId**</span>. Simply pass the <span style="color:#0078BD;">**valuationId**</span> value into the GET AVM Report endpoint to retrieve a professionally formatted report. For implementation details, refer to the <a href="https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-pdf">GET AVM Report</a>.

            '
          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.</br>This can be used to <a href="https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-sale-pdf">Generate a Report</a><br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>'
                    format: uuid
                    examples:
                    - 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2
                  valuationDate:
                    type: string
                    description: 'Date of the AVM valuation </br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span> <br>Format `YYYY-MM-DD`. </br>'
                    format: date
                    examples:
                    - '2022-05-22'
                  effectiveDate:
                    type: string
                    format: date
                    examples:
                    - '2022-05-22'
                    description: 'Effective date of requested estimate</br>Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date) </br>Format `YYYY-MM-DD`. </br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>'
                    example: '2026-02-28'
                  propertyId:
                    type: number
                    x-stoplight:
                      id: rwmxdhtez307w
                    example: 1234567
                    description: 'Unique identifier for a property

                      <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>

                      '
                  fullAddress:
                    type: string
                    description: 'Full address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    examples:
                    - 1/67 Louisa Rd, Birchgrove, NSW 2041
                  address:
                    type: object
                    description: 'the Structured address of the property, optional extra to the fullAddress<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    properties:
                      lotNumber:
                        type: string
                        description: 'Lot number of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - Lot 123
                      unitNumber:
                        type: string
                        description: 'Unit number of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - Unit 1
                      streetNumber:
                        type: string
                        description: 'Street number of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - '67'
                      streetName:
                        type: string
                        description: 'Street name of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - Louisa
                      streetType:
                        type: string
                        description: 'Street type of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - Rd
                      suburb:
                        type: string
                        description: 'Suburb of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - Birchgrove
                      state:
                        type: string
                        description: 'State of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - NSW
                      postCode:
                        type: string
                        description: 'Postcode of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - '2041'
                  matchQuality:
                    enum:
                    - excellent
                    - good
                    - ok
                    - poor
                    description: 'Defines the quality of the match returned</br>Refer to [Match Quality](https://developer.proptrack.com.au/docs/apis/guide#match-quality)Full address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    examples:
                    - EXCELLENT
                    type: string
                  estimatedValue:
                    type: number
                    description: 'The <span style="color:#0078BD;">SALE</span> estimated value for the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    examples:
                    - 785652
                  fsd:
                    type: number
                    description: '<span style="color:#0078BD;">SALE</span> forecast standard deviation of the AVM estimate<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    examples:
                    - 0.13907999992370604
                  confidenceLevel:
                    enum:
                    - HIGH CONFIDENCE
                    - MEDIUM CONFIDENCE
                    - LOW CONFIDENCE
                    description: 'The <span style="color:#0078BD;">SALE</span> confidence level, based on the FSD</br>Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>

                      '
                    examples:
                    - HIGH CONFIDENCE
                    type: string
                  lowerRangeValue:
                    type: number
                    description: 'The <span style="color:#0078BD;">SALE</span> lower range estimate of the AVM<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                      '
                    examples:
                    - 654123
                  upperRangeValue:
                    type: number
                    description: 'The <span style="color:#0078BD;">SALE</span> upper range estimate of the AVM<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                      '
                    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 <span style="color:#0078BD;">Rental</span> weekly estimated value for the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                      fsd:
                        type: number
                        x-stoplight:
                          id: miwv7ipmdpqxg
                        description: 'The <span style="color:#0078BD;">Rental</span> forecast standard deviation of the AVM estimate <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        example: 0.125
                      confidenceLevel:
                        x-stoplight:
                          id: ahgbbmeabcgwo
                        description: 'The <span style="color:#0078BD;">Rental</span> confidence level, based on the FSD <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        example: HIGH CONFIDENCE
                        enum:
                        - HIGH CONFIDENCE
                        - MEDIUM CONFIDENCE
                        - LOW CONFIDENCE
                      lowerRangeValue:
                        type: number
                        x-stoplight:
                          id: 28worhgfmohxu
                        description: 'The <span style="color:#0078BD;">Rental</span> lower range estimate of the AVM<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        example: 550
                      upperRangeValue:
                        type: number
                        x-stoplight:
                          id: wtqkvic7g230f
                        description: 'The <span style="color:#0078BD;">Rental</span> upper range estimate of the AVM <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        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 <span style="color:#0078BD;">Rental</span>  Listing details of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                      '
                    properties:
                      yield:
                        type: number
                        x-stoplight:
                          id: 7tbissdjuiwk7
                        example: 0.025
                        description: 'The <span style="color:#0078BD;">Rental Yield</span> of the Rental estimate <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                      fsd:
                        type: number
                        x-stoplight:
                          id: pdkvbaf95gsee
                        example: 0.254
                        description: 'The <span style="color:#0078BD;">Rental Yield</span> forecast standard deviation of the AVM estimate <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                      confidenceLevel:
                        x-stoplight:
                          id: 8fkdo9j6f5grp
                        description: 'The <span style="color:#0078BD;">Rental Yield</span> confidence level, based on the FSD <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        example: HIGH CONFIDENCE
                        enum:
                        - HIGH CONFIDENCE
                        - MEDIUM CONFIDENCE
                        - LOW CONFIDENCE
                      lowerRangeValue:
                        type: number
                        x-stoplight:
                          id: df13vlqcjyt9d
                        description: 'The <span style="color:#0078BD;">Rental Yield </span> lower range value <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        example: 0.018
                      upperRangeValue:
                        type: number
                        x-stoplight:
                          id: x49as3bg2s2jr
                        description: 'The <span style="color:#0078BD;">Rental Yield </span> upper range value <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        example: 0.03
                  usedAttributes:
                    type: object
                    description: 'The attributes used for the AVM valuation</br>Refer to [Updated Attributes](https://developer.proptrack.com.au/docs/apis/guide#updated-attributes)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    properties:
                      bedrooms:
                        type: number
                        description: 'Number of bedrooms<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 4
                      bathrooms:
                        type: number
                        description: 'Number of bathrooms<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 2
                      carSpaces:
                        type: number
                        description: 'Number of car spaces<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 2
                      propertyType:
                        description: 'Classification of the type of property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        example: house
                        enum:
                        - house
                        - unit
                      floorArea:
                        type: number
                        description: 'Floor space area (measured in m2)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 322
                      livingArea:
                        type: number
                        x-stoplight:
                          id: hef9zvur6j6zx
                        example: 125
                        description: 'Living area (measured in m2), excluding Carspaces <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                      landArea:
                        type: number
                        description: 'Land space area (measured in m2), not valid if Unit/Strata <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 605
                      landUse:
                        x-stoplight:
                          id: 0mi1ajo3b1zrz
                        description: 'Land Use classification of the property <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        example: RESIDENTIAL
                        enum:
                        - RESIDENTIAL
                        - OTHER
                      lat:
                        type: number
                        x-stoplight:
                          id: 768ymlpsbijk2
                        description: 'Latitude (Lat) used as a target point <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        example: -35.31788658
                      lon:
                        type: number
                        x-stoplight:
                          id: oz9sj1zpymi0d
                        description: 'Longitude (Lon) used as a target point <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        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 </br>Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 1030000
                      customerReference:
                        type: string
                        description: 'Customer supplied reference identifier for tracking or reconciliation purposes</br>Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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 <br>

                            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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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
  /api/v1/properties/{propertyId}/valuations/sale?requestType=plus:
    parameters:
    - schema:
        type: string
      name: propertyId
      in: path
      required: true
    get:
      tags:
      - AVM
      summary: /api/v1/properties/{propertyId}/valuations/sale?requestType=plus
      description: " <span style=\"color:#0078BD;\">**AVM Plus - by propertyId:**</span>  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 <span style=\"color:#0078BD;\">**propertyId**</span> , you can retrieve the latest and most accurate valuation available, enabling faster decisions and seamless integration into your business workflows.\n\n\n- <p style=\"color:#0078BD\"><b>Plus</B></p> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=plus</span></span> </p> 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</br>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</br>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 <span style="color:#0078BD;">**plus**</span> requestType is mandatory for all AVM Plus requests. </br> **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</br>Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)</br>Format `YYYY-MM-DD` <br>'
      - schema:
          type: string
          example: ABC123
        in: query
        name: customerReference
        description: '**Optional:** Client-defined reference key for tracking or reconciliation purposes. Maximum length: 50 characters</br>Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)<br>'
      - 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<br>'
      requestBody:
        content: {}
      responses:
        '200':
          description: "<!-- theme: success -->\n\n> #### Success (200)\nResponse delivers comprehensive Sale and Rental data to support informed property insights based on the <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=plus</span></span> 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 <span style=\"color:#0078BD;\">**valuationId**</span>. Simply pass the <span style=\"color:#0078BD;\">**valuationId**</span> value into the GET AVM Report endpoint to retrieve a professionally formatted report. For implementation details, refer to the <a href=\"https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-pdf\">GET AVM Report</a>.\n"
          content:
            application/json:
              schema:
                type: object
                properties:
                  valuationId:
                    type: string
                    description: 'Unique identifier for an AVM valuation.</br>This can be used to <a href="https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-sale-pdf">Generate a Report</a><br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span>'
                    examples:
                    - 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2
                  valuationDate:
                    type: string
                    description: 'Date of the AVM valuation </br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">plus</span>, Format `YYYY-MM-DD`. </br>'
                    format: date
                    examples:
                    - '2022-12-25'
                  effectiveDate:
                    type: string
                    description: 'Effective date of requested estimate</br>Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date) </br>Format `YYYY-MM-DD`. </br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>'
                    format: date
                    examples:
                    - '2022-12-25'
                  propertyId:
                    type: integer
                    description: 'Unique identifier for a property</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span>'
                    examples:
                    - 1234567
                  matchQuality:
                    x-stoplight:
                      id: ey15xpcjp27ub
                    description: 'Defines the quality of the match returned</br>Refer to [Match Quality](https://developer.proptrack.com.au/docs/apis/guide#match-quality)Full address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    example: excellent
                    enum:
                    - excellent
                    - good
                    - ok
                  estimatedValue:
                    type: integer
                    description: 'The <span style="color:#0078BD;">SALE</span> estimated value for the property</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>'
                    examples:
                    - 785652
                  fsd:
                    type: number
                    format: float
                    examples:
                    - 0.39079999923706055
                    description: '<span style="color:#0078BD;">SALE</span> forecast standard deviation of the AVM estimate. </br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span>'
                  confidenceLevel:
                    enum:
                    - HIGH CONFIDENCE
                    - MEDIUM CONFIDENCE
                    - LOW CONFIDENCE
                    description: 'The <span style="color:#0078BD;">SALE</span>  confidence level, based on the FSD</br>Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>'
                  upperRangeValue:
                    type: integer
                    examples:
                    - 875250
                    description: 'The <span style="color:#0078BD;">SALE</span> upper range estimate of the AVM.</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span>'
                  lowerRangeValue:
                    type: integer
                    description: 'The <span style="color:#0078BD;">SALE</span> lower range estimate of the AVM</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span>'
                    examples:
                    - 712352
                  rental:
                    type: object
                    x-stoplight:
                      id: 5hcrtx98zsrzi
                    description: Rental estimate
                    properties:
                      estimatedValue:
                        type: integer
                        x-stoplight:
                          id: isz8h6j8g1zdo
                        description: 'The <span style="color:#0078BD;">RENTAL</span> weekly estimated value for the property</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>'
                        example: 650
                      fsd:
                        type: number
                        x-stoplight:
                          id: 8cfhztyoxo136
                        description: '<span style="color:#0078BD;">RENTAL</span> forecast standard deviation of the AVM estimate. </br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span>'
                        example: 0.0828
                      confidenceLevel:
                        x-stoplight:
                          id: 2vjodjc3pmzig
                        description: 'The <span style="color:#0078BD;">RENTAL</span>  confidence level, based on the FSD</br>Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>'
                        example: MEDIUM CONFIDENCE
                        enum:
                        - HIGH CONFIDENCE
                        - MEDIUM CONFIDENCE
                        - LOW CONFIDENCE
                      lowerRangeValue:
                        type: number
                        x-stoplight:
                          id: d38crclfnr70w
                        description: 'The <span style="color:#0078BD;">RENTAL</span> upper range estimate of the AVM.</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span>'
                        example: 550
                      upperRangeValue:
                        type: number
                        x-stoplight:
                          id: owfazolcxqzu5
                        description: 'The <span style="color:#0078BD;">RENTAL</span> lower range estimate of the AVM</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span>'
                        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: '<span style="color:#0078BD;">RENTAL</span> Yield of the AVM estimate. </br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span>'
                      fsd:
                        type: number
                        x-stoplight:
                          id: j7a0t0ffpe4ni
                        example: 0.121
                        description: '<span style="color:#0078BD;">RENTAL</span> Yield forecast standard deviation of the AVM estimate. </br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span>'
                      confidenceLevel:
                        x-stoplight:
                          id: bdgoi3wp2wt9d
                        description: 'The <span style="color:#0078BD;">RENTAL</span> Yield confidence level, based on the FSD</br>Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>'
                        example: MEDIUM CONFIDENCE
                        enum:
                        - HIGH CONFIDENCE
                        - MEDIUM CONFIDENCE
                        - LOW CONFIDENCE
                      lowerRangeValue:
                        type: number
                        x-stoplight:
                          id: ecex77yk8021v
                        description: 'The <span style="color:#0078BD;">RENTAL</span> Yield lower range estimate of the AVM.</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span>'
                      upperRangeValue:
                        type: number
                        x-stoplight:
                          id: spl38zn3n3pkg
                        description: 'The <span style="color:#0078BD;">RENTAL</span> Yield Upper range estimate of the AVM</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span>'
                  usedAttributes:
                    type: object
                    description: 'The attributes used for the AVM valuation</br> Fields available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span>'
                    properties:
                      bedrooms:
                        type: number
                        description: 'Number of bedrooms</br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span>'
                        examples:
                        - 4
                      bathrooms:
                        type: number
                        description: 'Number of bathrooms</br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span>'
                        examples:
                        - 2
                      carSpaces:
                        type: number
                        description: 'Number of car spaces</br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span>'
                        examples:
                        - 2
                      propertyType:
                        enum:
                        - house
                        - unit
                        description: 'Classification of the type of property</br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span>'
                        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</br>Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>

                          '
                      customerReference:
                        type: string
                        x-stoplight:
                          id: do8ma4ue13xxa
                        description: 'Customer‑supplied reference identifier for tracking or reconciliation purposes</br>Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
              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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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 <br>

                            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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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
  /api/v1/properties/valuations/sale ~ Pro:
    parameters: []
    post:
      tags:
      - AVM
      summary: /api/v1/properties/valuations/sale ~ Pro
      description: "<span style=\"color:#0078BD;\">**AVM Pro - by address:**</span> 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 <span style=\"color:#0078BD;\">**fullAddress or address**</span> , you can retrieve the latest and most accurate valuation available, enabling faster decisions and seamless integration into your business workflows.\n\n\n- <p style=\"color:#0078BD\"><b>Plus</B></p> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=pro</span></span> </p> 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\n<span style=\"color:#0078BD\"><b>Note:</B></span> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=pro</span></span> 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</br>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 <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: lite-bold;">requestType=pro</span>, will generate the <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: lite-bold;">AVM Pro</span> response containing both Sales, rental and environmental hazards data in the same endpoint<span style="background-color: #f5f5f5; padding: 0.2em; font-weight: lite-bold;">requestType</span> 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<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>

                    '
                  examples:
                  - 1/67 Louisa Rd, Birchgrove, NSW 2041
                address:
                  type: object
                  description: 'Structured address of the property, either fullAddress or address not both allowed<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>

                    '
                  properties:
                    lotNumber:
                      type: string
                      description: 'Lot number of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>

                        '
                      examples:
                      - Lot 123
                    unitNumber:
                      type: string
                      description: 'Unit number of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>

                        '
                      examples:
                      - Unit 1
                    streetNumber:
                      type: string
                      description: 'Street number of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>

                        '
                      examples:
                      - '67'
                    streetName:
                      type: string
                      description: 'Street name of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>

                        '
                      examples:
                      - Louisa
                    streetType:
                      type: string
                      description: 'Street type of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>

                        '
                      examples:
                      - Rd
                    suburb:
                      type: string
                      description: 'Suburb of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>

                        '
                      examples:
                      - Birchgrove
                    state:
                      type: string
                      description: 'State of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>

                        '
                      examples:
                      - NSW
                    postCode:
                      type: string
                      description: 'Postcode of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>

                        '
                      examples:
                      - '2041'
                effectiveDate:
                  type: string
                  description: 'Effective date of requested estimate</br>Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)</br>Format `YYYY-MM-DD` <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                  format: date
                  examples:
                  - '2022-06-30'
                  example: '2026-02-28'
                updatedAttributes:
                  type: object
                  description: 'Customer supplied attributes</br>Refer to [Updated Attributes](https://developer.proptrack.com.au/docs/apis/guide#updated-attributes)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                  properties:
                    bedrooms:
                      type: integer
                      description: 'Number of bedrooms<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                      examples:
                      - 4
                    bathrooms:
                      type: integer
                      description: 'Number of bathrooms<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                      examples:
                      - 2
                    carSpaces:
                      type: integer
                      description: 'Number of car spaces<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                      examples:
                      - 2
                    propertyType:
                      enum:
                      - house
                      - unit
                      description: 'Classification of the type of property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                      type: string
                    landArea:
                      type: integer
                      description: 'Land space area (measured in m2)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                      examples:
                      - 605
                    floorArea:
                      type: integer
                      description: 'Floor space area (measured in m2)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                      examples:
                      - 322
                additionalInformation:
                  type: object
                  properties:
                    applicantEstimate:
                      type: integer
                      description: 'Applicant''s estimated value of the property</br>Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                      examples:
                      - 1030000
                    loanAmount:
                      type: integer
                      description: 'Outstanding loan amount on the property</br>Refer to [Loan Amount](https://developer.proptrack.com.au/docs/apis/guide#loan-amount)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                      examples:
                      - 850000
                    customerReference:
                      type: string
                      description: 'Customer Reference Key</br>Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                      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: '<!-- theme: success -->


            > #### 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 <span style="color:#0078BD;">**valuationId**</span>. Simply pass the <span style="color:#0078BD;">**valuationId**</span> value into the GET AVM Report endpoint to retrieve a professionally formatted report. For implementation details, refer to the <a href="https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-pdf">GET AVM Report</a>.

            '
          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.</br>This can be used to <a href="https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-sale-pdf">Generate a Report</a><br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>'
                    format: uuid
                    examples:
                    - 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2
                  valuationDate:
                    type: string
                    description: 'Date of the AVM valuation </br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span> <br>Format `YYYY-MM-DD`. </br>'
                    format: date
                    examples:
                    - '2022-05-22'
                  effectiveDate:
                    type: string
                    format: date
                    examples:
                    - '2022-05-22'
                    description: 'Effective date of requested estimate</br>Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date) </br>Format `YYYY-MM-DD`. </br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>'
                    example: '2026-02-28'
                  propertyId:
                    type: number
                    example: 1234567
                    description: 'Unique identifier for a property

                      <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>

                      '
                  fullAddress:
                    type: string
                    description: 'Full address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    examples:
                    - 1/67 Louisa Rd, Birchgrove, NSW 2041
                  address:
                    type: object
                    description: 'the Structured address of the property, optional extra to the fullAddress<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    properties:
                      lotNumber:
                        type: string
                        description: 'Lot number of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - Lot 123
                      unitNumber:
                        type: string
                        description: 'Unit number of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - Unit 1
                      streetNumber:
                        type: string
                        description: 'Street number of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - '67'
                      streetName:
                        type: string
                        description: 'Street name of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - Louisa
                      streetType:
                        type: string
                        description: 'Street type of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - Rd
                      suburb:
                        type: string
                        description: 'Suburb of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - Birchgrove
                      state:
                        type: string
                        description: 'State of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - NSW
                      postCode:
                        type: string
                        description: 'Postcode of the propertyFull address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - '2041'
                  matchQuality:
                    enum:
                    - excellent
                    - good
                    - ok
                    - poor
                    description: 'Defines the quality of the match returned</br>Refer to [Match Quality](https://developer.proptrack.com.au/docs/apis/guide#match-quality)Full address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    examples:
                    - EXCELLENT
                    type: string
                  estimatedValue:
                    type: number
                    description: 'The <span style="color:#0078BD;">SALE</span> estimated value for the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    examples:
                    - 785652
                  fsd:
                    type: number
                    description: '<span style="color:#0078BD;">SALE</span> forecast standard deviation of the AVM estimate<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    examples:
                    - 0.13907999992370604
                  confidenceLevel:
                    enum:
                    - HIGH CONFIDENCE
                    - MEDIUM CONFIDENCE
                    - LOW CONFIDENCE
                    description: 'The <span style="color:#0078BD;">SALE</span> confidence level, based on the FSD</br>Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>

                      '
                    examples:
                    - HIGH CONFIDENCE
                    type: string
                  lowerRangeValue:
                    type: number
                    description: 'The <span style="color:#0078BD;">SALE</span> lower range estimate of the AVM<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                      '
                    examples:
                    - 654123
                  upperRangeValue:
                    type: number
                    description: 'The <span style="color:#0078BD;">SALE</span> upper range estimate of the AVM<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                      '
                    examples:
                    - 875625
                  rental:
                    type: object
                    description: Rental estimate object
                    properties:
                      estimatedValue:
                        type: number
                        example: 650
                        description: 'The <span style="color:#0078BD;">Rental</span> weekly estimated value for the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                      fsd:
                        type: number
                        description: 'The <span style="color:#0078BD;">Rental</span> forecast standard deviation of the AVM estimate <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        example: 0.125
                      confidenceLevel:
                        description: 'The <span style="color:#0078BD;">Rental</span> confidence level, based on the FSD <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        example: HIGH CONFIDENCE
                        enum:
                        - HIGH CONFIDENCE
                        - MEDIUM CONFIDENCE
                        - LOW CONFIDENCE
                      lowerRangeValue:
                        type: number
                        description: 'The <span style="color:#0078BD;">Rental</span> lower range estimate of the AVM<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        example: 550
                      upperRangeValue:
                        type: number
                        description: 'The <span style="color:#0078BD;">Rental</span> upper range estimate of the AVM <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        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 <span style="color:#0078BD;">Rental</span>  Listing details of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                      '
                    properties:
                      yield:
                        type: number
                        example: 0.025
                        description: 'The <span style="color:#0078BD;">Rental Yield</span> of the Rental estimate <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                      fsd:
                        type: number
                        example: 0.254
                        description: 'The <span style="color:#0078BD;">Rental Yield</span> forecast standard deviation of the AVM estimate <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                      confidenceLevel:
                        description: 'The <span style="color:#0078BD;">Rental Yield</span> confidence level, based on the FSD <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        example: HIGH CONFIDENCE
                        enum:
                        - HIGH CONFIDENCE
                        - MEDIUM CONFIDENCE
                        - LOW CONFIDENCE
                      lowerRangeValue:
                        type: number
                        description: 'The <span style="color:#0078BD;">Rental Yield </span> lower range value <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        example: 0.018
                      upperRangeValue:
                        type: number
                        description: 'The <span style="color:#0078BD;">Rental Yield </span> upper range value <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span><br>

                          '
                        example: 0.03
                  usedAttributes:
                    type: object
                    description: 'The attributes used for the AVM valuation</br>Refer to [Updated Attributes](https://developer.proptrack.com.au/docs/apis/guide#updated-attributes)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                    properties:
                      bedrooms:
                        type: number
                        description: 'Number of bedrooms<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 4
                      bathrooms:
                        type: number
                        description: 'Number of bathrooms<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 2
                      carSpaces:
                        type: number
                        description: 'Number of car spaces<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 2
                      propertyType:
                        description: 'Classification of the type of property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        example: house
                        enum:
                        - house
                        - unit
                      floorArea:
                        type: number
                        description: 'Floor space area (measured in m2)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 322
                      floorArea_copy:
                        type: number
                        description: 'Floor space area (measured in m2)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 322
                      livingArea:
                        type: number
                        example: 125
                        description: 'Living area (measured in m2), excluding Carspaces <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                      landArea:
                        type: number
                        description: 'Land space area (measured in m2), not valid if Unit/Strata <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 605
                      landUse:
                        description: 'Land Use classification of the property <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        example: RESIDENTIAL
                        enum:
                        - RESIDENTIAL
                        - OTHER
                      lat:
                        type: number
                        description: 'Latitude (Lat) used as a target point <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        example: -35.31788658
                      lon:
                        type: number
                        description: 'Longitude (Lon) used as a target point <br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        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 </br>Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        examples:
                        - 1030000
                      customerReference:
                        type: string
                        description: 'Customer supplied reference identifier for tracking or reconciliation purposes</br>Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Plus</span></span><br>'
                        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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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 <br>

                            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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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
  /api/v1/properties/{propertyId}/valuations/sale?requestType=pro:
    parameters:
    - schema:
        type: string
      name: propertyId
      in: path
      required: true
    get:
      tags:
      - AVM
      summary: /api/v1/properties/{propertyId}/valuations/sale?requestType=pro
      description: " <span style=\"color:#0078BD;\">**AVM Pro - by propertyId:**</span>  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 <span style=\"color:#0078BD;\">**propertyId**</span> , you can retrieve the latest and most accurate valuation available, enabling faster decisions and seamless integration into your business workflows.\n\n\n- <p style=\"color:#0078BD\"><b>Pro</B></p> <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=pro</span></span> </p> 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</br>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</br>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 <span style="color:#0078BD;">**pro**</span> requestType is mandatory for all AVM Pro requests. </br> **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</br>Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date)</br>Format `YYYY-MM-DD` <br>'
      - schema:
          type: string
          example: ABC123
        in: query
        name: customerReference
        description: '**Optional:** Client-defined reference key for tracking or reconciliation purposes. Maximum length: 50 characters</br>Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)<br>'
      - 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<br>'
      requestBody:
        content: {}
      responses:
        '200':
          description: "<!-- theme: success -->\n\n> #### Success (200)\nResponse delivers comprehensive Sale, rental and environmental hazards data to support informed property insights based on the <span style=\"background-color: #f5f5f5; padding: 0.2em; font-weight: bold;\">requestType=pro</span></span> 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 <span style=\"color:#0078BD;\">**valuationId**</span>. Simply pass the <span style=\"color:#0078BD;\">**valuationId**</span> value into the GET AVM Report endpoint to retrieve a professionally formatted report. For implementation details, refer to the <a href=\"https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-pdf\">GET AVM Report</a>.\n"
          content:
            application/json:
              schema:
                type: object
                properties:
                  valuationId:
                    type: string
                    description: 'Unique identifier for an AVM valuation.</br>This can be used to <a href="https://developer.proptrack.com.au/docs/apis/reports/operations/get-a-api-v-1-report-valuation-sale-pdf">Generate a Report</a><br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>'
                    examples:
                    - 9a8b3368-fc5c-4a3d-9d4b-19ceecc387b2
                  valuationDate:
                    type: string
                    description: 'Date of the AVM valuation </br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>, Format `YYYY-MM-DD`. </br>'
                    format: date
                    examples:
                    - '2022-12-25'
                  effectiveDate:
                    type: string
                    description: 'Effective date of requested estimate</br>Refer to [Effective Date](https://developer.proptrack.com.au/docs/apis/guide#effective-date) </br>Format `YYYY-MM-DD`. </br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>'
                    format: date
                    examples:
                    - '2022-12-25'
                  propertyId:
                    type: integer
                    description: 'Unique identifier for a property</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>'
                    examples:
                    - 1234567
                  matchQuality:
                    description: 'Defines the quality of the match returned</br>Refer to [Match Quality](https://developer.proptrack.com.au/docs/apis/guide#match-quality)Full address of the property<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                    example: excellent
                    enum:
                    - excellent
                    - good
                    - ok
                  estimatedValue:
                    type: integer
                    description: 'The <span style="color:#0078BD;">SALE</span> estimated value for the property</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>'
                    examples:
                    - 785652
                  fsd:
                    type: number
                    format: float
                    examples:
                    - 0.39079999923706055
                    description: '<span style="color:#0078BD;">SALE</span> forecast standard deviation of the AVM estimate. </br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>'
                  confidenceLevel:
                    enum:
                    - HIGH CONFIDENCE
                    - MEDIUM CONFIDENCE
                    - LOW CONFIDENCE
                    description: 'The <span style="color:#0078BD;">SALE</span>  confidence level, based on the FSD</br>Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>'
                  upperRangeValue:
                    type: integer
                    examples:
                    - 875250
                    description: 'The <span style="color:#0078BD;">SALE</span> upper range estimate of the AVM.</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>'
                  lowerRangeValue:
                    type: integer
                    description: 'The <span style="color:#0078BD;">SALE</span> lower range estimate of the AVM</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>'
                    examples:
                    - 712352
                  rental:
                    type: object
                    description: Rental estimate
                    properties:
                      estimatedValue:
                        type: integer
                        description: 'The <span style="color:#0078BD;">RENTAL</span> weekly estimated value for the property</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>'
                        example: 650
                      fsd:
                        type: number
                        description: '<span style="color:#0078BD;">RENTAL</span> forecast standard deviation of the AVM estimate. </br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>'
                        example: 0.0828
                      confidenceLevel:
                        description: 'The <span style="color:#0078BD;">RENTAL</span>  confidence level, based on the FSD</br>Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>'
                        example: MEDIUM CONFIDENCE
                        enum:
                        - HIGH CONFIDENCE
                        - MEDIUM CONFIDENCE
                        - LOW CONFIDENCE
                      lowerRangeValue:
                        type: number
                        description: 'The <span style="color:#0078BD;">RENTAL</span> upper range estimate of the AVM.</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>'
                        example: 550
                      upperRangeValue:
                        type: number
                        description: 'The <span style="color:#0078BD;">RENTAL</span> lower range estimate of the AVM</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>'
                        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: '<span style="color:#0078BD;">RENTAL</span> Yield of the AVM estimate. </br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>'
                      fsd:
                        type: number
                        example: 0.121
                        description: '<span style="color:#0078BD;">RENTAL</span> Yield forecast standard deviation of the AVM estimate. </br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>'
                      confidenceLevel:
                        description: 'The <span style="color:#0078BD;">RENTAL</span> Yield confidence level, based on the FSD</br>Refer to [Confidence Level](https://developer.proptrack.com.au/docs/apis/guide#confidence-level)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span><br>'
                        example: MEDIUM CONFIDENCE
                        enum:
                        - HIGH CONFIDENCE
                        - MEDIUM CONFIDENCE
                        - LOW CONFIDENCE
                      lowerRangeValue:
                        type: number
                        description: 'The <span style="color:#0078BD;">RENTAL</span> Yield lower range estimate of the AVM.</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>'
                      upperRangeValue:
                        type: number
                        description: 'The <span style="color:#0078BD;">RENTAL</span> Yield Upper range estimate of the AVM</br> Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span>'
                  usedAttributes:
                    type: object
                    description: 'The attributes used for the AVM valuation</br> Fields available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span>'
                    properties:
                      bedrooms:
                        type: number
                        description: 'Number of bedrooms</br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span>'
                        examples:
                        - 4
                      bathrooms:
                        type: number
                        description: 'Number of bathrooms</br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span>'
                        examples:
                        - 2
                      carSpaces:
                        type: number
                        description: 'Number of car spaces</br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span>'
                        examples:
                        - 2
                      propertyType:
                        enum:
                        - house
                        - unit
                        description: 'Classification of the type of property</br> Field available in:  <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span>'
                        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</br>Refer to [Applicant Estimate](https://developer.proptrack.com.au/docs/apis/guide#applicant-estimate)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>

                          '
                      customerReference:
                        type: string
                        description: 'Customer‑supplied reference identifier for tracking or reconciliation purposes</br>Refer to [Customer Reference](https://developer.proptrack.com.au/docs/apis/guide#customerreference)<br>Field available in: <span style="background-color: #f5f5f5; padding: 0.2em; font-weight: bold;">Pro</span></span><br>'
                  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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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 <br>

                            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: '<!-- theme: danger -->


            > #### 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: '<!-- theme: danger -->


            > #### 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