openapi: 3.2.0
info:
  title: Domain Group Sales Results 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 SalesResults 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: SalesResults
paths:
  /v1/salesResults/_head:
    get:
      tags:
      - SalesResults
      summary: Get weekly results info
      operationId: SalesResults_Head
      responses:
        '200':
          description: Retrieves metadata regarding sales result data of the latest Saturday
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuctionResults.v1.infoResponse'
        '401':
          description: Unauthorized
        '500':
          description: Unexpected error
      security:
      - apikey: []
      - oauth2:
        - api_salesresults_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/salesResults/{city}:
    get:
      tags:
      - SalesResults
      summary: Get weekly results summary
      operationId: SalesResults_Get
      parameters:
      - name: city
        in: path
        required: true
        schema:
          type: string
          description: 'City. Supported cities are: Sydney, Melbourne, Brisbane, Adelaide, Canberra'
      responses:
        '200':
          description: Success. Retrieves summary of sales results for a given city for last Saturday
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuctionResults.v1.summaryResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '500':
          description: Unexpected error
      security:
      - apikey: []
      - oauth2:
        - api_salesresults_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/salesResults/{city}/listings:
    get:
      tags:
      - SalesResults
      summary: Get weekly results details
      operationId: SalesResults_Listings
      parameters:
      - name: city
        in: path
        required: true
        schema:
          type: string
          description: 'City. Supported cities are: Sydney, Melbourne, Brisbane, Adelaide, Canberra'
      responses:
        '200':
          description: Success. Retrieves listing events collection for last Saturday
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuctionResults.v1.listingEventItem'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '500':
          description: Unexpected error
      security:
      - apikey: []
      - oauth2:
        - api_salesresults_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/salesResults/saturday:
    get:
      tags:
      - SalesResults
      summary: Saturday report
      operationId: SalesResults_SaturdayReport
      responses:
        '200':
          description: Success. Retrieves Domain Saturday Auction Report for the last Saturday
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuctionResults.v1.saturdayAuctionResultResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '500':
          description: Unexpected error
      security:
      - apikey: []
      - oauth2:
        - api_salesresults_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/salesResults/weeklyMedia:
    get:
      tags:
      - SalesResults
      summary: Weekly media report
      operationId: SalesResults_WeeklyMediaReport
      responses:
        '200':
          description: Success. Retrieves Domain Weekly Auction Report for the last Saturday
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuctionResults.v1.weeklyMediaResultResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '500':
          description: Unexpected error
      security:
      - apikey: []
      - oauth2:
        - api_salesresults_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
components:
  schemas:
    AuctionResults.v1.summaryResponse:
      type: object
      properties:
        auctionedDate:
          type:
          - string
          - 'null'
          format: date
        lastModifiedDateTime:
          type:
          - string
          - 'null'
          format: date-time
        numberListedForAuction:
          type:
          - number
          - 'null'
        numberWithdrawn:
          type:
          - number
          - 'null'
        numberUnreported:
          type:
          - number
          - 'null'
        numberSold:
          type:
          - number
          - 'null'
        totalSales:
          type:
          - number
          - 'null'
        median:
          type:
          - number
          - 'null'
        adjClearanceRate:
          type:
          - number
          - 'null'
      additionalProperties: false
      description: Get report stats
    AuctionResults.v1.listingEventItem:
      type: object
      properties:
        unitNumber:
          type:
          - string
          - 'null'
        streetNumber:
          type:
          - string
          - 'null'
        streetName:
          type:
          - string
          - 'null'
        streetType:
          type:
          - string
          - 'null'
        suburb:
          type:
          - string
          - 'null'
        postcode:
          type:
          - string
          - 'null'
        state:
          type:
          - string
          - 'null'
        geoLocation:
          type:
          - object
          - 'null'
        propertyType:
          type:
          - string
          - 'null'
        bedrooms:
          type:
          - number
          - 'null'
        bathrooms:
          type:
          - number
          - 'null'
        carspaces:
          type:
          - number
          - 'null'
        price:
          type:
          - number
          - 'null'
        result:
          type:
          - string
          - 'null'
        agent:
          type:
          - string
          - 'null'
        agencyName:
          type:
          - string
          - 'null'
        agencyProfilePageUrl:
          type:
          - string
          - 'null'
        id:
          type:
          - number
          - 'null'
        agencyId:
          type:
          - number
          - 'null'
        propertyDetailsUrl:
          type:
          - string
          - 'null'
      additionalProperties: false
      description: Listing event details
    AuctionResults.v1.weeklyMediaResultResponse:
      type: object
      properties:
        auctionDate:
          type: string
          format: date
        results:
          type: array
          items:
            $ref: '#/components/schemas/AuctionResults.v1.weeklyMediaItem'
      additionalProperties: false
      description: Weekly media report response
    AuctionResults.v1.weeklyMediaItem:
      required:
      - region
      - scheduled
      - reported
      - sold
      - soldPrior
      - withdrawn
      - passedIn
      - medianPrice
      - totalSoldPrice
      - clearanceRate
      - clearanceRateLastYear
      type: object
      properties:
        region:
          enum:
          - Sydney
          - Melbourne
          - Brisbane
          - Adelaide
          - Perth
          - Canberra
          - Hobart
          - Darwin
          - National
          type: string
        scheduled:
          type: number
        reported:
          type: number
        sold:
          type: number
        soldPrior:
          type: number
        withdrawn:
          type: number
        passedIn:
          type: number
        privateSales:
          type:
          - number
          - 'null'
        medianPrice:
          type:
          - number
          - 'null'
        totalSoldPrice:
          type:
          - number
          - 'null'
        clearanceRate:
          type:
          - number
          - 'null'
        clearanceRateLastYear:
          type:
          - number
          - 'null'
        mostExpensiveSale:
          oneOf:
          - $ref: '#/components/schemas/AuctionResults.v1.propertySaleDetails'
          - type: 'null'
        leastExpensiveSale:
          oneOf:
          - $ref: '#/components/schemas/AuctionResults.v1.propertySaleDetails'
          - type: 'null'
      additionalProperties: false
      description: Email Weekly Media Report details
    AuctionResults.v1.infoResponse:
      type: object
      properties:
        auctionedDate:
          type: string
          description: Date of auction event
          format: date
        lastModifiedDateTime:
          type: string
          description: Date when results were published
          format: date-time
      additionalProperties: false
      description: Retrieves metadata regarding sales result data of the latest Saturday
    AuctionResults.v1.propertySaleDetails:
      title: Property Sale Details
      type: object
      properties:
        price:
          type: number
          description: Final sale price of the property
        address:
          type: string
          description: Full address of the property
          example: 123 Story Street, NSW
        bathrooms:
          type:
          - number
          - 'null'
        bedrooms:
          type:
          - number
          - 'null'
        carSpaces:
          type:
          - number
          - 'null'
    AuctionResults.v1.saturdayAuctionResultResponse:
      type: object
      properties:
        auctionDate:
          type: string
          format: date
        results:
          type: array
          items:
            $ref: '#/components/schemas/AuctionResults.v1.saturdayAuctionItem'
      additionalProperties: false
      description: Saturday auction results response
    AuctionResults.v1.saturdayAuctionItem:
      required:
      - region
      - scheduled
      - reported
      - sold
      - clearanceRate
      - mostExpensiveSale
      - leastExpensiveSale
      - top5
      type: object
      properties:
        region:
          enum:
          - Sydney
          - Melbourne
          - Brisbane
          - Adelaide
          - Perth
          - Canberra
          - Hobart
          - Darwin
          type: string
        scheduled:
          type: number
        reported:
          type: number
        sold:
          type: number
        clearanceRate:
          type:
          - number
          - 'null'
        mostExpensiveSale:
          oneOf:
          - $ref: '#/components/schemas/AuctionResults.v1.propertySaleDetails'
          - type: 'null'
        leastExpensiveSale:
          oneOf:
          - $ref: '#/components/schemas/AuctionResults.v1.propertySaleDetails'
          - type: 'null'
        top5:
          type: array
          items:
            type: string
      additionalProperties: false
      description: Saturday auction result item
  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