Domain Group Properties API

The Properties API from Domain Group — 10 operation(s) for properties.

Operations 10

GET /v1/properties/_suggest Search for suggested addresses for the given terms #
GET /v1/properties/{id} Property ID #
GET /v2/properties/{propertyId}/listings Retrieve list of listings for the given property id #
GET /v1/properties/{propertyId}/priceEstimate Price estimates based on propertyId #
GET /v1/properties/{propertyId}/rentalEstimate Rental estimates based on propertyId #
GET /v1/properties/images Property images #
GET /v1/properties/listingHistory Property Listing History #
GET /v1/properties/salesHistory Sales Listing History #
GET /v1/propertyenrichment Property #
GET /v1/propertyReports Retrieves a property report based on query parameters #

Documentation

📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_address_suggestion
📖
APIReference
https://developer.domain.com.au/docs/latest/apis/pkg_address_suggestion/references/properties_suggest
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings
📖
APIReference
https://developer.domain.com.au/docs/latest/apis/pkg_agents_listings/references/listings_detailedresidentialsearch
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_campaign_api
📖
APIReference
https://developer.domain.com.au/docs/latest/apis/pkg_campaign_api/references/campaign_getlistingperformance_report
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_campaign_api_preview
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_listing_management
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/guides/upload-listings
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/guides/agency-authorisation
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/guides/production-access
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_listing_management/guides/migrating-from-xml
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_price_estimation
📖
APIReference
https://developer.domain.com.au/docs/latest/apis/pkg_price_estimation/references/properties_getpriceestimate
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_properties_locations
📖
APIReference
https://developer.domain.com.au/docs/latest/apis/pkg_properties_locations/references/suburbperformance_get_bynamedsuburb
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_property_enrichment
📖
APIReference
https://developer.domain.com.au/docs/latest/apis/pkg_property_enrichment/references/propertyenrichment_get
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_property
📖
APIReference
https://developer.domain.com.au/docs/latest/apis/pkg_property/references/properties_get
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_propertyradar
📖
APIReference
https://developer.domain.com.au/docs/latest/apis/pkg_propertyradar/references/propertyradar_listportfolios
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_rental_avm
📖
APIReference
https://developer.domain.com.au/docs/latest/apis/pkg_rental_avm/references/properties_getrentalestimate
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_schools_data
📖
APIReference
https://developer.domain.com.au/docs/latest/apis/pkg_schools_data/references/schools_search_bylocation
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_webhooks
📖
Documentation
https://developer.domain.com.au/docs/latest/apis/pkg_webhooks/guides/subscriptions
📖
APIReference
https://developer.domain.com.au/docs/latest/apis/pkg_webhooks/references/webhooks_createsubscription

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/domain-group-properties-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

domain-group-properties-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Domain Group Properties API
  contact:
    name: Domain Developer Support
    email: api@domain.com.au
  termsOfService: https://developer.domain.com.au/docs/latest/support/terms
  version: '1.0'
  description: 'Operations tagged Properties across 3 of this provider''s published API definitions: domain-group-openapi-latest.json, domain-group-openapi-v1.json, domain-group-openapi-v2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.domain.com.au/
  description: Primary
- url: https://api.domain.com.au/sandbox/
  description: Sandbox
tags:
- name: Properties
paths:
  /v1/properties/_suggest:
    get:
      tags:
      - Properties
      summary: Search for suggested addresses for the given terms
      description: Applicable [policies](/docs/latest/support/policies) apply here include APM attribution.
      operationId: Properties_Suggest
      parameters:
      - name: terms
        in: query
        description: The address to search
        required: true
        schema:
          type: string
        example: 1 Smith Street, Smithfield, NSW
      - name: pageSize
        in: query
        schema:
          type: integer
          description: the size of the page. Defaults to 15 if unspecified
          default: 20
      - name: channel
        in: query
        description: 'Restrict the suggestions to this type of property: `All` (default), `Residential`, `Commercial`'
        schema:
          enum:
          - All
          - Residential
          - Commercial
          type: string
          default: All
      responses:
        '200':
          description: Sample record details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypeAhead.v2.PropertiesSuggest'
        '400':
          description: Bad request
        '404':
          description: Properties not found
        '500':
          description: Unexpected error
      security:
      - apikey: []
      - oauth2:
        - api_properties_read
      x-domain-endpointcost: 0
      x-domain-usercontextrequired: false
      x-domain-environment: Any
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
  /v1/properties/{id}:
    get:
      tags:
      - Properties
      summary: Property ID
      description: 'A propertyId is a Domain specific ID of particular property, usually in the form of an alphanumeric code: RF-8884-AK.'
      operationId: Properties_Get
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property.Enrichment.v2.Property'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: A property with the specified ID was not found
        '500':
          description: Unexpected error
      security:
      - apikey: []
      - oauth2:
        - api_properties_read
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Primary
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
  /v2/properties/{propertyId}/listings:
    get:
      tags:
      - Properties
      summary: Retrieve list of listings for the given property id
      operationId: listings_bypropertyid
      parameters:
      - name: propertyId
        in: path
        required: true
        schema:
          type: string
      - name: updatedSince
        in: query
        schema:
          type: string
          format: date-time
      - name: listedSince
        in: query
        schema:
          type: string
          format: date-time
      - name: saleMode
        in: query
        schema:
          enum:
          - sale
          - rent
          - both
          type: string
          default: both
      responses:
        '200':
          description: Listings for the property id
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Listings.V2.Listing'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
      - apikey: []
      - oauth2:
        - api_listings_read
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Any
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
  /v1/properties/{propertyId}/priceEstimate:
    get:
      tags:
      - Properties
      summary: Price estimates based on propertyId
      operationId: Properties_GetPriceEstimate
      parameters:
      - name: propertyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.PropertyPriceEstimate'
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.PropertyPriceEstimate'
            text/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.PropertyPriceEstimate'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
        '500':
          description: Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
      security:
      - apikey: []
      - oauth2:
        - api_properties_read
      x-domain-mapping-templates:
        Basic: $
        Detailed: $
        Full: $
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Primary
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
  /v1/properties/{propertyId}/rentalEstimate:
    get:
      tags:
      - Properties
      summary: Rental estimates based on propertyId
      operationId: Properties_GetRentalEstimate
      parameters:
      - name: propertyId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.RentalEstimate'
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.RentalEstimate'
            text/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.RentalEstimate'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
        '500':
          description: Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/DomainAvm.PI.v1.ProblemDetails'
      security:
      - apikey: []
      - oauth2:
        - api_properties_read
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Primary
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
  /v1/properties/images:
    get:
      tags:
      - Properties
      summary: Property images
      description: Search for a specific property and provide property images from latest sale/rental activity if found. Supply either propertyId, gnafId or all address fields (with flatNumber optional)
      operationId: property_images_get
      parameters:
      - name: propertyId
        in: query
        schema:
          type: string
      - name: gnafId
        in: query
        schema:
          type: string
      - name: flatNumber
        in: query
        schema:
          type: string
      - name: streetNumber
        in: query
        schema:
          type: string
      - name: streetName
        in: query
        schema:
          type: string
      - name: streetType
        in: query
        schema:
          type: string
      - name: postcode
        in: query
        schema:
          type: string
      - name: suburbName
        in: query
        schema:
          type: string
      - name: state
        in: query
        schema:
          enum:
          - ACT
          - NSW
          - NT
          - QLD
          - SA
          - TAS
          - VIC
          - WA
          - OT
          type: string
      responses:
        '200':
          description: Property matching specified criteria was found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property.Enrichment.v2.ImageResults'
        '300':
          description: Multiple records found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property.Enrichment.v2.MultiplePropertyResults'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: A property with the specified ID was not found
        '500':
          description: Unexpected error
      security:
      - apikey: []
      - oauth2:
        - api_properties_read
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Primary
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
  /v1/properties/listingHistory:
    get:
      tags:
      - Properties
      summary: Property Listing History
      description: Search for a specific property and provide property with comprehensive list of all sale/rental  listing activity for this property. Supply either propertyId, gnafId or all address fields (with flatNumber optional)
      operationId: property_listing_history_get
      parameters:
      - name: propertyId
        in: query
        schema:
          type: string
      - name: gnafId
        in: query
        schema:
          type: string
      - name: flatNumber
        in: query
        schema:
          type: string
      - name: streetNumber
        in: query
        schema:
          type: string
      - name: streetName
        in: query
        schema:
          type: string
      - name: streetType
        in: query
        schema:
          type: string
      - name: postcode
        in: query
        schema:
          type: string
      - name: suburbName
        in: query
        schema:
          type: string
      - name: state
        in: query
        schema:
          enum:
          - ACT
          - NSW
          - NT
          - QLD
          - SA
          - TAS
          - VIC
          - WA
          - OT
          type: string
      responses:
        '200':
          description: Property matching specified criteria was found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property.Enrichment.v2.PropertyListingResults'
        '300':
          description: Multiple records found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property.Enrichment.v2.MultiplePropertyResults'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: A property with the specified ID was not found
        '500':
          description: Unexpected error
      security:
      - apikey: []
      - oauth2:
        - api_properties_read
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Primary
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
  /v1/properties/salesHistory:
    get:
      tags:
      - Properties
      summary: Sales Listing History
      description: Search for a specific property's activities and provide sale/rental activity if found. Supply either propertyId, gnafId, or all address fields (with flatNumber optional)
      operationId: property_sales_history_get
      parameters:
      - name: propertyId
        in: query
        schema:
          type: string
      - name: gnafId
        in: query
        schema:
          type: string
      - name: flatNumber
        in: query
        schema:
          type: string
      - name: streetNumber
        in: query
        schema:
          type: string
      - name: streetName
        in: query
        schema:
          type: string
      - name: streetType
        in: query
        schema:
          type: string
      - name: postcode
        in: query
        schema:
          type: string
      - name: suburbName
        in: query
        schema:
          type: string
      - name: state
        in: query
        schema:
          enum:
          - ACT
          - NSW
          - NT
          - QLD
          - SA
          - TAS
          - VIC
          - WA
          - OT
          type: string
      responses:
        '200':
          description: Property matching specified criteria was found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property.Enrichment.v2.SaleHistory'
        '300':
          description: Multiple records found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property.Enrichment.v2.MultiplePropertyResults'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: A property with the specified ID was not found
        '500':
          description: Unexpected error
      security:
      - apikey: []
      - oauth2:
        - api_properties_read
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Primary
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
  /v1/propertyenrichment:
    get:
      tags:
      - Properties
      summary: Property
      description: Search for a specific property and provide property information and latest sale/rental activity if found. Supply either propertyId, gnafId, latitude/longitude, or all address fields (with flatNumber optional)
      operationId: propertyenrichment_get
      parameters:
      - name: propertyId
        in: query
        schema:
          type: string
      - name: gnafId
        in: query
        schema:
          type: string
      - name: flatNumber
        in: query
        schema:
          type: string
      - name: streetNumber
        in: query
        schema:
          type: string
      - name: streetName
        in: query
        schema:
          type: string
      - name: streetType
        in: query
        schema:
          type: string
      - name: postcode
        in: query
        schema:
          type: string
      - name: suburbName
        in: query
        schema:
          type: string
      - name: state
        in: query
        schema:
          enum:
          - ACT
          - NSW
          - NT
          - QLD
          - SA
          - TAS
          - VIC
          - WA
          - OT
          type: string
      responses:
        '200':
          description: Property matching specified criteria was found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property.Enrichment.v2.PropertyResults'
        '300':
          description: Multiple records found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Property.Enrichment.v2.MultiplePropertyResults'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: A property with the specified ID was not found
        '500':
          description: Unexpected error
      security:
      - apikey: []
      - oauth2:
        - api_properties_read
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Primary
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
  /v1/propertyReports:
    get:
      tags:
      - Properties
      summary: Retrieves a property report based on query parameters
      operationId: PropertyReports_Get
      parameters:
      - name: propertyType
        in: query
        description: Type of property `House`, `Unit`
        required: true
        schema:
          type: string
      - name: streetNumber
        in: query
        description: Street number
        required: true
        schema:
          type: string
      - name: streetName
        in: query
        description: Street name
        required: true
        schema:
          type: string
      - name: suburb
        in: query
        description: Suburb e.g. `Pyrmont`
        required: true
        schema:
          type: string
      - name: state
        in: query
        description: State e.g. `NSW`
        required: true
        schema:
          type: string
      - name: unitNumber
        in: query
        description: Unit number
        schema:
          type: string
      - name: streetType
        in: query
        description: Street type e.g. `Pl`
        schema:
          type: string
      - name: postcode
        in: query
        description: Postcode e.g. `2009`
        schema:
          type: string
      - name: areaSize
        in: query
        description: Area size
        schema:
          type: integer
          format: int32
      - name: bedrooms
        in: query
        description: Number of bedrooms
        schema:
          type: integer
          format: int32
      - name: bathrooms
        in: query
        description: Number of bathrooms
        schema:
          type: integer
          format: int32
      - name: parking
        in: query
        description: Number of parking spots
        schema:
          type: integer
          format: int32
      - name: preparedFor
        in: query
        description: '"Prepared for" information'
        schema:
          type: string
      - name: productCode
        in: query
        description: Report product code
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Domain.PropertyReportService.v1.Model.PropertyReportGenerationResult'
            text/json:
              schema:
                $ref: '#/components/schemas/Domain.PropertyReportService.v1.Model.PropertyReportGenerationResult'
            text/html:
              schema:
                $ref: '#/components/schemas/Domain.PropertyReportService.v1.Model.PropertyReportGenerationResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/Domain.PropertyReportService.v1.Model.PropertyReportGenerationResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/Domain.PropertyReportService.v1.Model.PropertyReportGenerationResult'
      security:
      - apikey: []
      - oauth2:
        - api_propertyreports_read
      x-domain-usercontextrequired: false
      x-domain-endpointcost: 1
      x-domain-environment: Any
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
components:
  schemas:
    Property.Enrichment.v2.PropertyListingResults:
      type: object
      properties:
        propertyId:
          type: string
        addressComponents:
          $ref: '#/components/schemas/Property.Enrichment.v2.AddressBasic'
        salesListingHistory:
          type: array
          items:
            $ref: '#/components/schemas/Property.Enrichment.v2.saleListingHistory'
        rentListingHistory:
          type: array
          items:
            $ref: '#/components/schemas/Property.Enrichment.v2.rentListingHistory'
      description: property listing history object
    Listings.V2.AddressParts:
      type: object
      properties:
        stateAbbreviation:
          enum:
          - nsw
          - vic
          - sa
          - nt
          - tas
          - act
          - qld
          - wa
          type:
          - string
          - 'null'
          description: Gets or Sets StateAbbreviation
        displayType:
          enum:
          - fullAddress
          - streetAndSuburb
          - suburbOnly
          - regionOnly
          - areaOnly
          - stateOnly
          type:
          - string
          - 'null'
          description: Gets or Sets DisplayType
        streetNumber:
          type:
          - string
          - 'null'
          description: Street number
        unitNumber:
          type:
          - string
          - 'null'
          description: Unit number.
        street:
          type:
          - string
          - 'null'
          description: Street address
        suburb:
          type:
          - string
          - 'null'
          description: Suburb of the address
        suburbId:
          type:
          - integer
          - 'null'
          description: Domain suburb identifier for address lookup via the domain location api
          format: int32
        postcode:
          type:
          - string
          - 'null'
          description: Postcode of the address
        displayAddress:
          type:
          - string
          - 'null'
          description: Advertiser's preference in displaying their listing's address
      additionalProperties: false
      description: Encapsulates the parts that make up an Address
      x-data-access-level-info:
        Basic:
        - DisplayAddress
        - DisplayType
        - StateAbbreviation
        - Postcode
        - Suburb
        - SuburbId
        - UnitNumber
        - StreetNumber
        - Street
        Detailed:
        - DisplayAddress
        - DisplayType
        - StateAbbreviation
        - Postcode
        - Suburb
        - SuburbId
        - UnitNumber
        - StreetNumber
        - Street
        Full:
        - DisplayAddress
        - DisplayType
        - StateAbbreviation
        - Postcode
        - Suburb
        - SuburbId
        - UnitNumber
        - StreetNumber
        - Street
    Listings.V2.SaleDetails:
      type: object
      properties:
        saleMethod:
          enum:
          - notStated
          - auction
          - privateTreaty
          - tender
          - expressionOfInterest
          type:
          - string
          - 'null'
          description: Gets or Sets SaleMethod
        soldDetails:
          $ref: '#/components/schemas/Listings.V2.SoldDetails'
        auctionDetails:
          $ref: '#/components/schemas/Listings.V2.AuctionDetails'
        tenderDetails:
          $ref: '#/components/schemas/Listings.V2.TenderDetails'
        tenantDetails:
          $ref: '#/components/schemas/Listings.V2.TenantDetails'
        annualReturn:
          type:
          - integer
          - 'null'
          description: Integer value of percentage return on this property or business
          format: int32
        saleTerms:
          type:
          - string
          - 'null'
          description: Information relating to aspects of the sale, such as required deposit, settlement time
      additionalProperties: false
      description: The sale detail's of the listing in case of it being for sale or sold
      x-data-access-level-info:
        Basic:
        - '*'
        Detailed:
        - '*'
        Full:
        - '*'
    Property.Enrichment.v2.Property.Activity.SummaryBasic:
      type: object
      properties:
        lastRentedDate:
          type:
          - string
          - 'null'
        lastSoldDate:
          type:
          - string
          - 'null'
        lastListedDateRent:
          type:
          - string
          - 'null'
        lastListedDateSale:
          type:
          - string
          - 'null'
        ownerRenter:
          enum:
          - Owner
          - Renter
          type:
          - string
          - 'null'
          description: Whether the most recent known activity indicates that the current resident is the owner or renter
        marketStatus:
          enum:
          - on-market
          - off-market
          type: string
      additionalProperties: false
      description: Property activity summary derived from property activity events (not currently in EVENT-SCHEMAS project)
    Property.Enrichment.v2.RentHistoryListing:
      type: object
      properties:
        id:
          type: string
        agencyName:
          type:
          - string
          - 'null'
        agencyId:
          type:
          - integer
          - 'null'
        firstListedDate:
          type:
          - string
          - 'null'
          description: First activity date in YYYY-MM-DD format
          format: date
        lastListedDate:
          type:
          - string
          - 'null'
          description: Last activity date in YYYY-MM-DD format
          format: date
        lastListedPrice:
          type:
          - number
          - 'null'
        daysOnMarket:
          type:
          - integer
          - 'null'
    DomainAvm.PI.v1.PropertyPriceEstimate:
      type: object
      properties:
        date:
          type:
          - string
          - 'null'
        lowerPrice:
          type:
          - number
          - 'null'
          format: double
        midPrice:
          type:
          - number
          - 'null'
          format: double
        priceConfidence:
          $ref: '#/components/schemas/DomainAvm.PI.v1.ConfidenceEnum'
        source:
          type:
          - string
          - 'null'
        upperPrice:
          type:
          - number
          - 'null'
          format: double
        history:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DomainAvm.PI.v1.PropertyPriceEstimateHistory'
      additionalProperties: false
      x-data-access-level-info:
        Basic:
        - '*'
        Detailed:
        - '*'
        Full:
        - '*'
    Listings.V2.PropertyInspections:
      type: object
      properties:
        inspections:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Listings.V2.Inspection'
          description: Inspection details for the property. e.g. opening and closing times
        pastInspections:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Listings.V2.Inspection'
          description: Inspection details for the property. e.g. opening and closing times
        isByAppointmentOnly:
          type:
          - boolean
          - 'null'
          description: True or False indicating whether the inspection is by appointment only
      additionalProperties: false
      description: Property Inspection(s) details
      x-data-access-level-info:
        Basic:
        - '*'
        Detailed:
        - '*'
        Full:
        - '*'
    Property.Enrichment.v2.Advert:
      type: object
      properties:
        onMarketTypes:
          type:
          - array
          - 'null'
          items:
            enum:
            - Unknown
            - Rent
            - Sale
            - Share
            type: string
        advertId:
          type:
          - integer
          - 'null'
        agency:
          type:
          - string
          - 'null'
        agencyId:
          type:
          - integer
          - 'null'
        url:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: Advert of properties
    Property.Enrichment.v2.MultiplePropertyResults:
      type: object
      properties:
        properties:
          type: array
          items:
            type: object
            properties:
              propertyId:
                type: string
              addressComponents:
                $ref: '#/components/schemas/Property.Enrichment.v2.AddressBasic'
    Listings.V2.TenantDetails:
      type: object
      properties:
        leaseDateVariable:
          type:
          - boolean
          - 'null'
          description: Is tenant lease date variable
        leaseOptions:
          type:
          - string
          - 'null'
          description: Leasing options available to a prospective tenant
        tenantInfoTermOfLeaseFrom:
          type:
          - integer
          - 'null'
          description: The from range of the tenant's current lease
          format: int32
        tenantInfoTermOfLeaseTo:
          type:
          - integer
          - 'null'
          description: The to range of the tenant's current lease
          format: int32
        tenantName:
          type:
          - string
          - 'null'
          description: Name of the current tenant of the property
        tenantRentDetails:
          type:
          - string
          - 'null'
          description: Information regarding current rental
        leaseStartDate:
          type:
          - string
          - 'null'
          description: The date on which the tenants lease began, or is due to begin. DateTime is in a local timezone.
          format: date-ti

# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/domain-group/refs/heads/main/openapi/domain-group-properties-api-openapi.yml