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-time leaseEndDate: type: - string - 'null' description: The date on which the tenants lease is due to end. DateTime is in a local timezone. format: date-time additionalProperties: false description: Tenant Details x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Property.Enrichment.v2.PropertyId-History: type: object properties: rentals: type: array items: type: object properties: id: type: integer format: int64 first: $ref: '#/components/schemas/Property.Enrichment.v2.PropertyId-ActivityBoundary' last: $ref: '#/components/schemas/Property.Enrichment.v2.PropertyId-ActivityBoundary' propertyType: type: - string - 'null' sales: type: array items: $ref: '#/components/schemas/Property.Enrichment.v2.PropertyId-Sales' description: Array of Rental and History Items DomainAvm.PI.v1.ProblemDetails: type: object properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} Property.Enrichment.v2.AddressBasic: type: object properties: flatNumber: type: - string - 'null' streetNumber: type: string streetName: type: string streetType: type: - string - 'null' streetTypeLong: type: - string - 'null' suburb: type: string postcode: type: string state: type: string additionalProperties: false description: Address of property ProblemDetails: type: object properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Property.Enrichment.v2.saleListingHistory: type: object properties: id: type: string agencyId: type: - integer - 'null' agencyName: type: - string - 'null' firstListedDate: type: - string - 'null' description: First listed in YYYY-MM-DD format format: date lastListedDate: type: - string - 'null' description: Last listed in YYYY-MM-DD format format: date lastListedPrice: type: - integer - 'null' daysOnMarket: type: - integer - 'null' soldDate: type: - string - 'null' description: Sold date in YYYY-MM-DD format format: date soldPrice: type: - number - 'null' description: sold price saleType: type: - string - 'null' withdrawn: type: - boolean - 'null' additionalProperties: false description: property listing history object Property.Enrichment.v2.ImageTypes: enum: - ListingPhoto - OldFloorPlanPhoto - NewFloorPlanPhoto - BuildingPhoto - NewDevelopmentLandPhoto - NewDevelopmentLumierePhoto - NewDevelopmentFeaturedPhoto - ConjunctionAgentLogo - NewDevelopmentRegionalPhoto - AdvertiserImage - YouWishClip - AgentCarousel - DevelopmentProjectGalleryPhoto - DevelopmentProjectAdvertisementPhoto Listings.V2.AustralianPropertyMonitorsIdentifiers: type: object properties: addressId: type: - integer - 'null' description: APM address identifier format: int32 streetId: type: - integer - 'null' description: APM street identifier format: int32 suburbId: type: - integer - 'null' description: APM suburb identifier format: int32 cadastreId: type: - integer - 'null' description: APM cadastre identifier format: int64 postcodeId: type: - integer - 'null' description: APM postcode identifier format: int32 stateId: type: - integer - 'null' description: State identifier format: int32 state: type: - string - 'null' description: APM State propertyTypeId: type: - integer - 'null' description: APM property type identifier format: int32 propertyTypeCategoryId: type: - integer - 'null' description: APM property category type identifier format: int32 streetNumber: type: - string - 'null' description: APM washed and standardized address component for the street number, (including any prefixes, suffixed and composite numbers e.g. \"2-4a\") additionalProperties: false description: APM Identifiers x-data-access-level-info: Basic: [] Detailed: - SuburbId Full: - SuburbId - AddressId - CadastreId - PostcodeId - PropertyTypeCategoryId - PropertyTypeId - State - StateId - StreetId - StreetNumber Listings.V2.SoldDetails: type: object properties: soldAction: enum: - notStated - auction - privateTreaty - withdrawn - soldPriorToAuction type: - string - 'null' description: Gets or Sets SoldAction source: enum: - internal - external type: - string - 'null' description: Gets or Sets Source soldPrice: type: - integer - 'null' description: The last sold price entered by the Advertiser. This price will only be visible if allowed by the Advertiser and the listing as been sold format: int32 governmentRecordedSoldPrice: type: - integer - 'null' description: The government recorded sold price sourced from APM format: int32 soldDate: type: - string - 'null' description: The Date the listing was sold. DateTime is in a local timezone. format: date-time canDisplayPrice: type: - boolean - 'null' description: Indicates whether this instance can display price additionalProperties: false description: Sold details in the case of the listing being sold. x-data-access-level-info: Basic: - CanDisplayPrice - SoldAction - SoldPrice - SoldDate - Source Detailed: - CanDisplayPrice - SoldAction - SoldPrice - SoldDate - Source Full: - CanDisplayPrice - SoldAction - SoldPrice - SoldDate - Source - GovernmentRecordedSoldPrice Property.Enrichment.v2.Claim: type: object properties: claimant: enum: - Owner - Tenant - Investor - Unspecified type: - string - 'null' description: Advert of properties Domain.PropertyReportService.v1.Model.WashedLocation: type: object properties: unitNumber: type: string streetNumber: type: string streetName: type: string streetType: type: string suburb: type: string postcode: type: string state: type: string x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Listings.V2.PastSaleData: type: object properties: unitNumber: type: - string - 'null' description: Property unit number streetNumber: type: - string - 'null' description: Property street number street: type: - string - 'null' description: Property Street name suburb: type: - string - 'null' description: Property suburb name postcode: type: - string - 'null' description: Property postcode state: type: - string - 'null' description: Property state displayAddress: type: - string - 'null' description: display formatted address readOnly: true dateOfSale: type: - string - 'null' description: Registered date of the sale soldPrice: type: - integer - 'null' description: Property sold price format: int64 additionalProperties: false description: Information for past property sales x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Property.Enrichment.v2.PropertyId-ActivityBoundary: type: object properties: advertisedDate: type: - string - 'null' format: date-time advertisedPrice: type: - integer - 'null' agency: type: - string - 'null' agencyId: type: - integer - 'null' source: type: - string - 'null' suppressDetails: type: - boolean - 'null' suppressPrice: type: - boolean - 'null' type: type: - string - 'null' url: type: - string - 'null' listingId: type: - integer - 'null' additionalProperties: false description: Property History Activity Record Property.Enrichment.v2.ImageUrl: type: object properties: advertId: type: integer description: Internal Domain advertisement identifier advertDate: type: - string - 'null' description: The date when advertisement was created in YYYY-MM-DD format format: date images: type: array items: type: object properties: imageUrl: type: string description: URL of image source imageType: $ref: '#/components/schemas/Property.Enrichment.v2.ImageTypes' additionalProperties: false additionalProperties: false description: Description of advertisement image Listings.V2.TenderDetails: type: object properties: tenderRecipientName: type: - string - 'null' description: Tender recipient name tenderAddress: type: - string - 'null' description: Tender address tenderEndDate: type: - string - 'null' description: Tender closing date. DateTime is in a local timezone. format: date-time additionalProperties: false description: Tender details x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Listings.V2.AuctionDetails: type: object properties: auctionSchedule: $ref: '#/components/schemas/Listings.V2.AuctionSchedule' auctionedPrice: type: - integer - 'null' description: The auctioned price entered by the Advertiser. This price will only be visible if allowed by the Advertiser and the listing as been auctioned format: int32 auctionedDate: type: - string - 'null' description: The listing's last auctioned date and time specified by the Advertiser. This will only be visible if the listing has been auctioned. DateTime is in a local timezone. format: date-time additionalProperties: false description: The detail's of the auction in case of a listing for sale being auctioned or sold by auction x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Property.Enrichment.v2.coordinates: type: object properties: lat: type: - number - 'null' lon: type: - number - 'null' description: Longitude/Latitude coordinates Property.Enrichment.v2.PropertyId-Sales: type: object properties: advertId: type: - string - 'null' agency: type: - string - 'null' agencyId: type: - integer - 'null' agencyUrl: type: - string - 'null' apmAgencyId: type: - integer - 'null' date: type: - string - 'null' format: date daysOnMarket: type: - number - 'null' format: double documentedAsSold: type: - boolean - 'null' price: type: - integer - 'null' reportedAsSold: type: - boolean - 'null' suppressDetails: type: - boolean - 'null' suppressPrice: type: - boolean - 'null' type: type: - string - 'null' url: type: - string - 'null' first: $ref: '#/components/schemas/Property.Enrichment.v2.PropertyId-ActivityBoundary' id: type: - integer - 'null' format: int64 last: $ref: '#/components/schemas/Property.Enrichment.v2.PropertyId-ActivityBoundary' propertyType: type: - string - 'null' additionalProperties: false Listings.V2.ProviderDetails: type: object properties: providerSystem: type: - string - 'null' description: Feed provider ID providerAdID: type: - string - 'null' description: Unique ID within provider system additionalProperties: false description: Information for the listing provider. e.g. bulkuploader information x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' DomainAvm.PI.v1.ConfidenceEnum: enum: - high - medium - low type: string Listings.V2.GeoLocation: type: object properties: latitude: type: - number - 'null' description: Latitude of the property format: double longitude: type: - number - 'null' description: Longitude of the property format: double additionalProperties: false description: Encapsulates the details of a geo location, long/lat x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Property.Enrichment.v2.PropertyResults: type: object properties: propertyId: type: string description: Unique ID for the property addressComponents: $ref: '#/components/schemas/Property.Enrichment.v2.AddressBasic' propertySummary: oneOf: - $ref: '#/components/schemas/Property.Enrichment.v2.Property.SummaryFull' - $ref: '#/components/schemas/Property.Enrichment.v2.Property.SummaryBasic' description: Summary of property information x-data-access-level-info: Basic: - propertyType - bedrooms - bathrooms - carSpaces - landSize - internalArea - yearBuilt Detailed: - propertyType - bedrooms - bathrooms - carSpaces - landSize - buildingSize - internalArea - yearBuilt Full: - '*' activitySummary: oneOf: - $ref: '#/components/schemas/Property.Enrichment.v2.Property.Activity.SummaryFull' - $ref: '#/components/schemas/Property.Enrichment.v2.Property.Activity.SummaryBasic' description: Summary of latest rental and sale records x-data-access-level-info: Basic: - lastRentedDate - lastSoldDate - lastListedDateRent - lastListedDateSale - ownerRenter - marketStatus Detailed: - lastListedDate - lastSoldDate - lastRentedDate - lastListedPrice - lastSoldPrice - lastRentedPrice - ownerRenter Full: - '*' Property.Enrichment.v2.Property.SummaryBasic: type: object properties: propertyType: type: - string - 'null' bedrooms: type: - string - 'null' bathrooms: type: - string - 'null' carSpaces: type: - string - 'null' landSize: type: - string - 'null' hasStrata: type: - boolean - 'null' internalArea: type: - string - 'null' yearBuilt: type: - number - 'null' additionalProperties: false description: Property summary (not currently in EVENT-SCHEMAS project) TypeAhead.v2.PropertiesSuggest: type: array items: type: object properties: address: type: string addressComponents: type: object properties: unitNumber: type: string streetNumber: type: string streetName: type: string streetType: type: string streetTypeLong: type: string suburb: type: string postCode: type: string state: type: string id: type: string relativeScore: type: integer DomainAvm.PI.v1.PropertyPriceEstimateHistory: type: object properties: confidence: $ref: '#/components/schemas/DomainAvm.PI.v1.ConfidenceEnum' date: type: - string - 'null' lowerPrice: type: - number - 'null' format: double midPrice: type: - number - 'null' format: double source: type: - string - 'null' upperPrice: type: - number - 'null' format: double additionalProperties: false x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Property.Enrichment.v2.PropertyAddress-v2: required: - streetNumber - streetName - suburb - postcode - state type: object properties: flatNumber: type: - string - 'null' streetNumber: type: string streetName: type: string streetType: type: - string - 'null' streetTypeLong: type: - string - 'null' suburb: type: string postcode: type: string state: type: string description: Address of property Property.Enrichment.v2.SaleHistory: type: object properties: propertyId: type: string description: Unique ID for the property addressComponents: $ref: '#/components/schemas/Property.Enrichment.v2.AddressBasic' salesHistory: type: array items: $ref: '#/components/schemas/Property.Enrichment.v2.SaleHistoryListing' description: An array of the sale histories for the listing rentalHistory: type: array items: $ref: '#/components/schemas/Property.Enrichment.v2.RentHistoryListing' description: An array of the rent histories for the listing Listings.V2.Listing: required: - advertiserIdentifiers - id - propertyTypes type: object properties: objective: enum: - sale - rent type: - string - 'null' description: Gets or Sets Objective status: enum: - unknown - archived - underOffer - sold - leased - newDevelopment - recentlyUpdated - new - live - pending - depositTaken type: - string - 'null' description: Gets or Sets Status saleMode: enum: - buy - rent - share - sold - leased - archived type: - string - 'null' description: Gets or Sets SaleMode channel: enum: - residential - commercial - business type: - string - 'null' description: Gets or Sets Channel id: type: integer description: The identifier which uniquely identifies the listing. format: int32 addressParts: $ref: '#/components/schemas/Listings.V2.AddressParts' advertiserIdentifiers: $ref: '#/components/schemas/Listings.V2.AdvertiserIdentifiers' apmIdentifiers: $ref: '#/components/schemas/Listings.V2.AustralianPropertyMonitorsIdentifiers' bathrooms: type: - number - 'null' description: Total number of bathrooms in the property format: float bedrooms: type: - number - 'null' description: Total number of bedrooms in the property; Studio apartments have a value of \"0\" format: float buildingArea: type: - string - 'null' description: The building area display value of the property e.g. 160 ha buildingAreaSqm: type: - number - 'null' description: The properties building area in square meters format: double carspaces: type: - number - 'null' description: Total number of car spaces in the property. format: float dateAvailable: type: - string - 'null' description: The date the property is available. DateTime is in a local timezone. format: date-time dateCreated: type: - string - 'null' description: The date/time the listing was created. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone. format: date-time dateUpdated: type: - string - 'null' description: The date/time the listing had major update. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone. format: date-time dateMinorUpdated: type: - string - 'null' description: When minor update applied to the listing. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone. format: date-time datePurged: type: - string - 'null' description: The date/time the listing was purged. It's only returned for archived listings. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone. format: date-time dateListed: type: - string - 'null' description: The date/time last listed. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone. format: date-time description: type: - string - 'null' description: The long description of the property provided by the advertiser. devProjectId: type: - integer - 'null' description: The ID of the development project - null if no associated project format: int32 energyEfficiencyRating: type: - integer - 'null' description: Energy Efficiency Rating value for ACT properties format: int32 features: type: - array - 'null' items: type: string description: The property features specified by the advertiser geoLocation: $ref: '#/components/schemas/Listings.V2.GeoLocation' headline: type: - string - 'null' description: The short description of the property provided by the advertiser. inspectionDetails: $ref: '#/components/schemas/Listings.V2.PropertyInspections' isNewDevelopment: type: - boolean - 'null' description: Indicates whether the property is a new development landArea: type: - string - 'null' description: The land area display string for the property e.g. 160 sqm landAreaSqm: type: - number - 'null' description: The properties land area in square meters format: double media: type: - array - 'null' items: $ref: '#/components/schemas/Listings.V2.ListingMedia' description: The media associated with the property provided by the advertiser priceDetails: $ref: '#/components/schemas/Listings.V2.PriceDetails' propertyId: type: - string - 'null' description: The identifier which uniquely identifies the property being advertised. This may be empty if the Address of property is poorly described propertyTypes: type: array items: enum: - unknown - acreageSemiRural - apartmentUnitFlat - aquaculture - blockOfUnits - carspace - dairyFarming - developmentLand - developmentSite - duplex - farm - fishingForestry - homeBased - newHomeDesigns - hotelLeisure - house - newHouseLand - industrialWarehouse - irrigationServices - newLand - livestock - international - medicalConsulting - newApartments - offices - parkingCarSpace - penthouse - retail - retirement - rural - ruralCommercialFarming - semiDetached - showroomsBulkyGoods - specialistFarm - studio - terrace - townhouse - vacantLand - villa - servicedOffices - other - chickenShop - seafoodShop - deliCafe - cropping - viticulture - mixedFarming - grazing - horticulture - equine - farmlet - orchard - ruralLifestyle - onlineBusiness type: string description: Available types of Properties * `Unknown` - Unknown * `AcreageSemiRural` - Acreage-SemiRural * `ApartmentUnitFlat` - Apartment Unit Flat * `Aquaculture` - Aquaculture commercial/rural type * `BlockOfUnits` - Block Of Units * `Carspace` - Carspace * `DairyFarming` - Dairy Farming commercial/rural type * `DevelopmentLand` - Development / Land * `DevelopmentSite` - Development site * `Duplex` - Duplex * `Farm` - Farm * `FishingForestry` - Fishing / Forestry commercial/rural type * `HomeBased` - Home Based * `NewHomeDesigns` - New Home Designs * `HotelLeisure` - Hotel / Leisure commercial type * `House` - House * `NewHouseLand` - New House And Land * `IndustrialWarehouse` - Industrial / Warehouse commercial type * `IrrigationServices` - Irrigation Services commercial/rural type * `NewLand` - New Land * `Livestock` - Livestock commercial/rural type * `International` - International commercial type * `MedicalConsulting` - Medical / Consulting commercial type * `NewApartments` - New Apartments / Off the Plan * `Offices` - Offices commercial type * `ParkingCarSpace` - Parking / Car Space commercial type * `Penthouse` - Penthouse * `Retail` - Retail commercial type * `Retirement` - Retirement * `Rural` - Rural * `RuralCommercialFarming` - Rural / Commercial Farming commercial type * `SemiDetached` - Semi Detached * `ShowroomsBulkyGoods` - Showrooms / Bulky Goods commercial type * `SpecialistFarm` - The specialist farm * `Studio` - Studio * `Terrace` - Terrace * `Townhouse` - The townhouse * `VacantLand` - Vacant Land * `Villa` - Villa * `ServicedOffices` - Serviced Offices commercial type * `Other` - Other commercial type * `ChickenShop` - Chicken Shop commercial type * `SeafoodShop` - Seafood Shop commercial type * `DeliCafe` - Deli Cafe commercial type * `Cropping` - Cropping commercial/rural type * `Viticulture` - Viticulture commercial/rural type * `MixedFarming` - Mixed Farming commercial type * `Grazing` - Grazing commercial/rural type * `Horticulture` - Horticulture commercial/rural type * `Equine` - Equine commercial/rural type * `Farmlet` - Farmlet commercial/rural type * `Orchard` - Orchard commercial/rural type * `RuralLifestyle` - Rural Lifestyle commercial/rural type * `OnlineBusiness` - Online Business description: Types of the property providerDetails: $ref: '#/components/schemas/Listings.V2.ProviderDetails' rentalDetails: $ref: '#/components/schemas/Listings.V2.RentalDetails' saleDetails: $ref: '#/components/schemas/Listings.V2.SaleDetails' isWithdrawn: type: - boolean - 'null' description: Indicates if the property has been withdrawn from the market The value will be 'true' When a listing is taken off market without being sold or leased. seoUrl: type: - string - 'null' description: Listing SEO URL virtualTourUrl: type: - string - 'null' description: The Listing's Virtual Tour URL. homepassEnabled: type: - boolean - 'null' description: If Homepass is enabled for the listing (agency) statementOfInformation: $ref: '#/components/schemas/Listings.V2.StatementOfInformation' numberOfDwellings: type: - integer - 'null' description: Number of dwellings for current listing format: int32 highlights: type: - array - 'null' items: type: string description: Highlight items for the listing additionalProperties: false description: Represents a Property Listing x-data-access-level-info: Basic: - Id - Status Detailed: - Id - Status - RentalDetails - NumberOfDwellings - PropertyId - ApmIdentifiers - AddressParts - AdvertiserIdentifiers - Bathrooms - Bedrooms - BuildingAreaSqm - Carspaces - Channel - DateAvailable - DateListed - DateUpdated - Description - DevProjectId - EnergyEfficiencyRating - Features - GeoLocation - Headline - Highlights - InspectionDetails - IsNewDevelopment - LandAreaSqm - Media - Objective - PriceDetails - PropertyTypes - SaleDetails - SaleMode - SeoUrl - StatementOfInformation - VirtualTourUrl Full: - Id - Status - RentalDetails - NumberOfDwellings - PropertyId - ApmIdentifiers - AddressParts - AdvertiserIdentifiers - Bathrooms - Bedrooms - BuildingAreaSqm - Carspaces - Channel - DateAvailable - DateListed - DateUpdated - Description - DevProjectId - EnergyEfficiencyRating - Features - GeoLocation - Headline - Highlights - InspectionDetails - IsNewDevelopment - LandAreaSqm - Media - Objective - PriceDetails - PropertyTypes - SaleDetails - SaleMode - SeoUrl - StatementOfInformation - VirtualTourUrl - BuildingArea - DateCreated - DateMinorUpdated - DatePurged - ProviderDetails - HomepassEnabled - IsWithdrawn - LandArea Property.Enrichment.v2.Property: type: object properties: cadastreType: enum: - Point - MultiPoint - LineString - MultiLineString - Polygon - MultiPolygon - GeometryCollection - Feature - FeatureCollection type: - string - 'null' onMarketTypes: type: - array - 'null' items: enum: - Sale - Rent - Share - Unknown - null type: string status: enum: - OffMarket - OnMarket type: string address: type: string addressCoordinate: $ref: '#/components/schemas/Property.Enrichment.v2.coordinates' addressId: type: integer adverts: type: array items: $ref: '#/components/schemas/Property.Enrichment.v2.Advert' bathrooms: type: - integer - 'null' bedrooms: type: - integer - 'null' carSpaces: type: - integer - 'null' claim: $ref: '#/components/schemas/Property.Enrichment.v2.Claim' created: type: - string - 'null' features: type: - array - 'null' items: type: string flatNumber: type: - string - 'null' history: $ref: '#/components/schemas/Property.Enrichment.v2.PropertyId-History' id: type: - string - 'null' internalArea: type: - string - 'null' yearBuilt: type: - number - 'null' isResidential: type: - boolean - 'null' landUse: type: - string - 'null' lotNumber: type: - string - 'null' photos: type: array items: $ref: '#/components/schemas/Property.Enrichment.v2.PropertyId-Photo' planNumber: type: - string - 'null' postcode: type: - string - 'null' propertyCategory: type: - string - 'null' propertyCategoryId: type: - integer - 'null' propertyType: type: - string - 'null' propertyTypeId: type: - integer - 'null' state: type: - string - 'null' storeys: type: - string - 'null' streetAddress: type: - string - 'null' streetName: type: - string - 'null' streetNumber: type: - string - 'null' streetType: type: - string - 'null' streetTypeLong: type: - string - 'null' suburb: type: - string - 'null' suburbId: type: - integer - 'null' title: type: - string - 'null' updated: type: - string - 'null' format: date urlSlug: type: - string - 'null' urlSlugShort: type: - string - 'null' zone: type: - string - 'null' gnafIds: type: array items: type: object properties: monthNo: type: - integer - 'null' yearNo: type: - integer - 'null' gnafPID: type: - string - 'null' areaSize: type: - integer - 'null' canonicalUrl: type: - string - 'null' hasStrata: type: - boolean - 'null' Property.Enrichment.v2.Property.Activity.SummaryFull: type: object properties: lastRentedDate: type: - string - 'null' lastRentedPrice: type: - number - 'null' lastSoldDate: type: - string - 'null' lastSoldPrice: type: - number - 'null' lastListedDateRent: type: - string - 'null' lastListedPriceRent: type: - number - 'null' lastListedDateSale: type: - string - 'null' lastListedPriceSale: type: - number - 'null' ownerRenter: enum: - Owner - Renter type: - string - 'null' marketStatus: enum: - on-market - off-market type: - string - 'null' additionalProperties: false description: Property activity summary derived from property activity events (not currently in EVENT-SCHEMAS project) Property.Enrichment.v2.ImageResults: type: object properties: propertyId: type: string description: Unique ID for the property addressComponents: $ref: '#/components/schemas/Property.Enrichment.v2.PropertyAddress-v2' adverts: type: array items: $ref: '#/components/schemas/Property.Enrichment.v2.ImageUrl' Domain.PropertyReportService.v1.Model.PropertyReportContainer: type: object properties: mimeType: type: string content: type: string format: byte x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Listings.V2.PriceDetails: type: object properties: gstOption: enum: - na - inc - ex type: - string - 'null' description: Gets or Sets GstOption priceType: enum: - gross - net type: - string - 'null' description: Gets or Sets PriceType priceUnit: enum: - totalAmount - perSqm type: - string - 'null' description: Gets or Sets PriceUnit price: type: - number - 'null' description: Price of the property format: double priceFrom: type: - integer - 'null' description: Price starting range of the property format: int32 priceTo: type: - integer - 'null' description: Upper price range of the property format: int32 pricePrefix: type: - string - 'null' description: Display price for the advertisement canDisplayPrice: type: - boolean - 'null' description: Flag indicating whether the advertiser has chosen to display the property price hiddenReasons: type: - array - 'null' items: enum: - byAgency - qldRestriction type: string description: Reason for price hidden * `ByAgency` - Agency doesn't want to show prcie * `QLDRestriction` - Price can not be shown due to QLD restrictions description: Reasons when price need to be hidden displayPrice: type: - string - 'null' description: A string provided by the Advertiser representing the ByIdListingPriceQueryResult of the Listing e.g. Over $1,000,000 This should be the default price field for client to use bond: type: - number - 'null' description: Rental bond format: double priceReduction: type: - boolean - 'null' description: Indicates if this property is under price reduction additionalProperties: false description: Encapsulates a listing's price information x-data-access-level-info: Basic: - DisplayPrice - Bond - CanDisplayPrice - Price - PriceFrom - PriceTo - PricePrefix Detailed: - DisplayPrice - Bond - CanDisplayPrice - Price - PriceFrom - PriceTo - PricePrefix Full: - DisplayPrice - Bond - CanDisplayPrice - Price - PriceFrom - PriceTo - PricePrefix - HiddenReasons - GstOption - PriceUnit - PriceType - PriceReduction Property.Enrichment.v2.Property.SummaryFull: type: object properties: propertyType: type: - string - 'null' bedrooms: type: - string - 'null' bathrooms: type: - string - 'null' carSpaces: type: - string - 'null' landSize: type: - string - 'null' buildingSize: type: - string - 'null' hasStrata: type: - boolean - 'null' internalArea: type: - string - 'null' yearBuilt: type: - number - 'null' additionalProperties: false description: Property summary (not currently in EVENT-SCHEMAS project) Property.Enrichment.v2.PropertyId-Photo: type: object properties: imageType: enum: - Property - Floorplan - GoogleStreetView type: - string - 'null' advertId: type: - integer - 'null' date: type: - string - 'null' format: date fullUrl: type: - string - 'null' rank: type: - integer - 'null' additionalProperties: false Property.Enrichment.v2.SaleHistoryListing: 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' soldDate: type: - string - 'null' description: Sold date in YYYY-MM-DD format format: date soldPrice: type: - number - 'null' description: sold price saleType: type: - string - 'null' description: Sale type ['Auction', 'Private Treaty'] Listings.V2.StatementOfInformation: type: object properties: estimatedPrice: $ref: '#/components/schemas/Listings.V2.BasicPrice' comparableData: $ref: '#/components/schemas/Listings.V2.ComparableData' suburbMedianPrice: $ref: '#/components/schemas/Listings.V2.MedianPriceData' documentationUrl: type: - string - 'null' description: Link to the statement of information documentation file additionalProperties: false description: Statement of Information Regarding sale listing x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Domain.PropertyReportService.v1.Model.PropertyReportGenerationResult: type: object properties: washedLocation: $ref: '#/components/schemas/Domain.PropertyReportService.v1.Model.WashedLocation' report: $ref: '#/components/schemas/Domain.PropertyReportService.v1.Model.PropertyReportContainer' x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Listings.V2.Inspection: type: object properties: recurrence: enum: - none - weekly type: - string - 'null' description: Gets or Sets Recurrence openingDateTime: type: - string - 'null' description: Opening date and time of the inspection. e.g. 2015-01-01T12:00:00. Not provided by bulk uploaded listings, in these cases refer to the inspection description field. DateTime is in a local timezone. format: date-time closingDateTime: type: - string - 'null' description: Closing date and time of the inspection. e.g. 2015-01-01T12:00:00 Not provided by bulk uploaded listings, in these cases refer to the inspection description field. DateTime is in a local timezone. format: date-time description: type: - string - 'null' description: Description of the inspection provided by the Advertiser. When listings are bulk uploaded, inspection times are provided as a string. Other inspection details will not be provided additionalProperties: false description: Encapsulates the details of a Listing's Inspection x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' DomainAvm.PI.v1.RentalEstimate: type: object properties: weeklyRentEstimate: type: - integer - 'null' format: int32 percentYieldRentEstimate: type: - number - 'null' format: double rentalFsd: type: - number - 'null' format: double estimateDate: type: - string - 'null' propertyType: type: - string - 'null' additionalProperties: false x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Listings.V2.RentalDetails: type: object properties: rentalMethod: enum: - notStated - rent - share - holiday - lease type: - string - 'null' description: Gets or Sets RentalMethod source: enum: - internal - external type: - string - 'null' description: Gets or Sets Source leasedDate: type: - string - 'null' description: The Date the listing was leased. DateTime is in a local timezone. format: date-time leasedPrice: type: - integer - 'null' description: The last leased price entered by the Advertiser This price will only be visible if allowed by the Advertiser and the listing as been leased format: int32 canDisplayPrice: type: - boolean - 'null' description: Indicates whether this instance can display price leasedMonths: type: - integer - 'null' description: The number of months the property was last leased for This will only be visible if the property has been leased format: int32 termOfLeaseFrom: type: - integer - 'null' description: Lease term range from format: int32 termOfLeaseTo: type: - integer - 'null' description: Lease term range to format: int32 leaseOutgoings: type: - integer - 'null' description: Outgoing cost of current lease format: int32 additionalProperties: false description: The rental detail's of the listing in case of it being for rent or leased x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Listings.V2.AuctionSchedule: type: object properties: locationDescription: type: - string - 'null' description: Description and location of the auction provided by advertiser openingDateTime: type: - string - 'null' description: Opening date and time of the auction. e.g. 2015-01-01T12:00:00 DateTime is in a local timezone. format: date-time terms: type: - string - 'null' description: Terms of the auction url: maxLength: 255 type: - string - 'null' description: On-line URL of the auction additionalProperties: false description: Encapsulates the details of a Property being Auctioned. x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Listings.V2.AdvertiserIdentifiers: type: object properties: advertiserType: enum: - agency - private type: - string - 'null' description: Gets or Sets AdvertiserType advertiserId: type: - integer - 'null' description: Advertiser's identifier format: int32 contactIds: type: - array - 'null' items: type: integer format: int32 description: Identifier of each contact the advertiser has associated with the listing agentIds: type: - array - 'null' items: type: string description: Identifier of each agent the advertiser has associated with the listing conjunctionContactIds: type: - array - 'null' items: type: integer format: int32 description: Identifier of each conjunctional contact associated with the listing conjunctionAgentIds: type: - array - 'null' items: type: string description: Identifier of each conjunctional agent associated with the listing additionalProperties: false description: Encapsulates the listing's advertiser identifiers x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Listings.V2.ComparableData: type: object properties: comparableProperty: type: - array - 'null' items: $ref: '#/components/schemas/Listings.V2.PastSaleData' description: Comparable properties that are of a similar standard or condition to the property for sale declarationText: type: - string - 'null' description: Text description if there are less than three comparable sales available additionalProperties: false description: Information regarding the past comparable property sales that influenced the setting of the estimation price x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Property.Enrichment.v2.rentListingHistory: type: object properties: id: type: string agencyId: type: - integer - 'null' agencyName: type: - string - 'null' firstListedDate: type: - string - 'null' description: First listed date in YYYY-MM-DD format format: date lastListedDate: type: - string - 'null' description: last listed date in YYYY-MM-DD format format: date lastListedPrice: type: - number - 'null' daysOnMarket: type: - integer - 'null' additionalProperties: false description: property listing history object Listings.V2.ListingMedia: required: - url type: object properties: category: enum: - image - video - others type: - string - 'null' description: Gets or Sets Category type: enum: - photo - mp4 - youtube - floorplan - vimeo - notSpecified type: - string - 'null' description: Gets or Sets Type url: minLength: 1 type: string description: The URL to the property media additionalProperties: false description: Encapsulates media associated with a Listing x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Listings.V2.BasicPrice: type: object properties: from: type: - integer - 'null' description: Lowest price the property is expected to sell/rent for to set search price. format: int32 to: type: - integer - 'null' description: Highest price the property is expected to sell/rent for to set search price. format: int32 additionalProperties: false description: Basic price information x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' Listings.V2.MedianPriceData: type: object properties: priceType: enum: - house - apartmentUnitFlat - vacantLand type: - string - 'null' description: Gets or Sets PriceType suburb: type: - string - 'null' description: Name of the suburb median price is based on. postcode: type: - string - 'null' description: Postcode of the suburb medianPrice: type: - integer - 'null' description: Median price for the suburb. format: int32 source: type: - string - 'null' description: Where median price data comes from sourceDateFrom: type: - string - 'null' description: Start date of the median price source time period sourceDateTo: type: - string - 'null' description: End date of the median price source time period sourceCollectionDate: type: - string - 'null' description: The collection date of the median price source additionalProperties: false description: Information regarding median house/unit price for the suburb x-data-access-level-info: Basic: - '*' Detailed: - '*' Full: - '*' securitySchemes: apikey: type: apiKey description: API Key in Header name: x-api-key in: header oauth2: type: oauth2 description: OAuth 2 flows: clientCredentials: tokenUrl: https://auth.domain.com.au/v1/connect/token scopes: api_addresslocators_read: api_addresslocators_read api_agencies_read: api_agencies_read api_agencies_write: api_agencies_write api_authorities_write: api_authorities_write api_avm_read: api_avm_read api_campaignperformance_read: api_campaignperformance_read api_dataset_read: api_dataset_read api_demographics_read: api_demographics_read api_enquiries_read: api_enquiries_read api_enquiries_write: api_enquiries_write api_listingperformance_read: api_listingperformance_read api_listings_read: api_listings_read api_listings_write: api_listings_write api_locations_read: api_locations_read api_projectperformance_read: api_projectperformance_read api_properties_read: api_properties_read api_propertyportfolio_read: api_propertyportfolio_read api_propertyportfolio_write: api_propertyportfolio_write api_propertyreports_read: api_propertyreports_read api_salesresults_read: api_salesresults_read api_statistics_write: api_statistics_write api_suburbhistorical_read: api_suburbhistorical_read api_suburbperformance_read: api_suburbperformance_read api_suburbsummary_read: api_suburbsummary_read api_webhooks_write: api_webhooks_write authorizationCode: authorizationUrl: https://auth.domain.com.au/v1/connect/authorize tokenUrl: https://auth.domain.com.au/v1/connect/token refreshUrl: https://auth.domain.com.au/v1/connect/token scopes: api_addresslocators_read: api_addresslocators_read api_agencies_read: api_agencies_read api_agencies_write: api_agencies_write api_authorities_write: api_authorities_write api_avm_read: api_avm_read api_campaignperformance_read: api_campaignperformance_read api_dataset_read: api_dataset_read api_demographics_read: api_demographics_read api_enquiries_read: api_enquiries_read api_enquiries_write: api_enquiries_write api_listingperformance_read: api_listingperformance_read api_listings_read: api_listings_read api_listings_write: api_listings_write api_locations_read: api_locations_read api_projectperformance_read: api_projectperformance_read api_properties_read: api_properties_read api_propertyportfolio_read: api_propertyportfolio_read api_propertyportfolio_write: api_propertyportfolio_write api_propertyreports_read: api_propertyreports_read api_salesresults_read: api_salesresults_read api_statistics_write: api_statistics_write api_suburbhistorical_read: api_suburbhistorical_read api_suburbperformance_read: api_suburbperformance_read api_suburbsummary_read: api_suburbsummary_read api_webhooks_write: api_webhooks_write x-refined-from: - domain-group-openapi-latest.json - domain-group-openapi-v1.json - domain-group-openapi-v2.json