openapi: 3.2.0
info:
  title: Pricefinder Sales API
  version: 1.13.1
  contact:
    name: Pricefinder
  license:
    name: Terms and Conditions
    url: https://www.domain.com.au/group/api-terms-and-conditions/
  description: 'Operations tagged sales across 2 of this provider''s published API definitions: pricefinder-api-swagger.json, pricefinder-api-swagger.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /v1
tags:
- name: sales
paths:
  /sales/{saleId}:
    get:
      tags:
      - sales
      description: ''
      operationId: sale
      parameters:
      - name: saleId
        in: path
        required: true
        pds:
          hidden: false
          extra: false
          enumerate: false
          deprecated: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtendedSale'
    servers:
    - url: /v1
components:
  schemas:
    Purchaser:
      type: object
      properties:
        firstName:
          type: string
        surname:
          type: string
        address:
          $ref: '#/components/schemas/Address'
    SensitivePrice:
      type: object
      properties:
        display:
          type: string
        value:
          type: number
          format: double
        rawValue:
          type: number
          format: double
        withheld:
          type: boolean
    SuburbIdentifier:
      type: object
      properties:
        id:
          type: string
        _self:
          type: string
    Agency:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        phoneNumber:
          type: string
    SaleParticipants:
      type: object
      properties:
        vendorsSummary:
          type: string
        purchasersSummary:
          type: string
        vendors:
          type: array
          items:
            $ref: '#/components/schemas/Vendor'
        purchasers:
          type: array
          items:
            $ref: '#/components/schemas/Purchaser'
    ExtendedSale:
      type: object
      properties:
        id:
          type: integer
          format: int64
        disclaimer:
          type: string
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Message'
        price:
          $ref: '#/components/schemas/SensitivePrice'
        listingHistory:
          $ref: '#/components/schemas/SaleListingHistory'
        saleDate:
          $ref: '#/components/schemas/SensitiveDate'
        settlementDate:
          $ref: '#/components/schemas/SensitiveDate'
        contractDate:
          $ref: '#/components/schemas/SensitiveDate'
        image:
          $ref: '#/components/schemas/ImageIdentifier'
        property:
          $ref: '#/components/schemas/PropertyIdentifier'
        street:
          $ref: '#/components/schemas/StreetIdentifier'
        suburb:
          $ref: '#/components/schemas/SuburbIdentifier'
        propertyType:
          type: string
        saleType:
          type: string
        agency:
          $ref: '#/components/schemas/Agency'
        agent:
          $ref: '#/components/schemas/Agent'
        location:
          $ref: '#/components/schemas/Point'
        metadata:
          $ref: '#/components/schemas/SaleMetadata'
        address:
          $ref: '#/components/schemas/ExtendedAddress'
        alternativeAddresses:
          type: array
          items:
            $ref: '#/components/schemas/ExtendedAddress'
        propertyFeatures:
          $ref: '#/components/schemas/ExtendedPropertyFeatures'
        landDetails:
          $ref: '#/components/schemas/LandDetails'
        rpd:
          type: string
        dealingNumber:
          type: string
        streetDisplay:
          type: string
        lowAskPrice:
          type: integer
          format: int64
        highAskPrice:
          type: integer
          format: int64
        saleParticipants:
          $ref: '#/components/schemas/SaleParticipants'
        saleMethod:
          type: string
        _self:
          type: string
    Message:
      type: object
      properties:
        code:
          type: integer
          format: int64
        text:
          type: string
    Vendor:
      type: object
      properties:
        firstName:
          type: string
        surname:
          type: string
        address:
          $ref: '#/components/schemas/Address'
    ImageIdentifier:
      type: object
      properties:
        id:
          type: integer
          format: int64
        _self:
          type: string
    SensitiveDate:
      type: object
      properties:
        display:
          type: string
        value:
          type: string
          format: date-time
        rawValue:
          type: string
          format: date-time
    ListingIdentifier:
      type: object
      properties:
        id:
          type: integer
          format: int64
        rental:
          type: boolean
        _self:
          type: string
    Point:
      type: object
      properties:
        lat:
          type: number
          format: double
        lon:
          type: number
          format: double
    ExtendedAddress:
      type: object
      properties:
        street:
          type: string
        unit:
          type: string
        level:
          type: string
        lot:
          type: string
        streetNumber:
          type: string
        streetAddress:
          type: string
        locality:
          type: string
        streetLocation:
          type: string
        state:
          type: string
        postcode:
          type: string
        countryCode:
          type: string
        streetName:
          type: string
        streetSuffix:
          type: string
        streetType:
          type: string
        ruralAddress:
          type: string
        unitType:
          type: string
        unitNumber:
          type: string
        unitNumberInt:
          type: integer
          format: int64
        unitNumberPrefix:
          type: string
        unitNumberSuffix:
          type: string
        levelType:
          type: string
        levelNumber:
          type: string
        levelNumberInt:
          type: integer
          format: int64
        levelNumberPrefix:
          type: string
        levelNumberSuffix:
          type: string
        lotType:
          type: string
        lotNumber:
          type: string
        lotNumberInt:
          type: integer
          format: int64
        lotNumberPrefix:
          type: string
        lotNumberSuffix:
          type: string
        numberFirst:
          type: string
        numberFirstInt:
          type: integer
          format: int64
        numberFirstPrefix:
          type: string
        numberFirstSuffix:
          type: string
        numberLast:
          type: string
        numberLastInt:
          type: integer
          format: int64
        numberLastPrefix:
          type: string
        numberLastSuffix:
          type: string
        localityType:
          type: string
        localityName:
          type: string
        careOfAddress:
          type: string
        other:
          type: string
        lga:
          type: string
    AgencyIdentifier:
      type: object
      properties:
        id:
          type: integer
          format: int64
    Address:
      type: object
      properties:
        street:
          type: string
        unit:
          type: string
        level:
          type: string
        lot:
          type: string
        streetNumber:
          type: string
        streetAddress:
          type: string
        locality:
          type: string
        streetLocation:
          type: string
        state:
          type: string
        postcode:
          type: string
        countryCode:
          type: string
        streetName:
          type: string
        streetSuffix:
          type: string
        streetType:
          type: string
        lga:
          type: string
    StreetIdentifier:
      type: object
      properties:
        id:
          type: string
    SensitiveChange:
      type: object
      properties:
        display:
          type: string
        value:
          type: number
          format: double
        rawValue:
          type: number
          format: double
    SaleMetadata:
      type: object
      properties:
        governmentSale:
          type: boolean
        pending:
          type: boolean
    PropertyIdentifier:
      type: object
      properties:
        id:
          type: integer
          format: int64
        matchlevel:
          type: string
          enum:
          - suburb
          - street
          - property
        location:
          $ref: '#/components/schemas/Point'
        parent:
          type: boolean
        _self:
          type: string
    LandDetails:
      type: object
      properties:
        propertyArea:
          type: number
          format: double
        buildingArea:
          type: number
          format: double
        volumeFolio:
          type: string
    Agent:
      type: object
      properties:
        name:
          type: string
        phoneNumber:
          type: string
        agency:
          $ref: '#/components/schemas/AgencyIdentifier'
    ExtendedPropertyFeatures:
      type: object
      properties:
        bedrooms:
          type: integer
          format: int64
        bathrooms:
          type: integer
          format: int64
        carParks:
          type: integer
          format: int64
        rumpusRoom:
          type: boolean
        airConditioning:
          type: boolean
        doubleStorey:
          type: boolean
        highSet:
          type: boolean
        multiLevel:
          type: boolean
        splitLevel:
          type: boolean
        brickTile:
          type: boolean
        contemporary:
          type: boolean
        postWar:
          type: boolean
        queenslander:
          type: boolean
        ensuite:
          type: boolean
        study:
          type: boolean
        verandah:
          type: boolean
        builtIn:
          type: boolean
        modernKitchen:
          type: boolean
        pool:
          type: boolean
        scenicViews:
          type: boolean
        waterFrontage:
          type: boolean
        closeSchools:
          type: boolean
        closeTransport:
          type: boolean
        lowSet:
          type: boolean
        colonial:
          type: boolean
        entertainmentArea:
          type: boolean
        sleepout:
          type: boolean
        boreWater:
          type: boolean
        dams:
          type: boolean
        fullyFenced:
          type: boolean
        otherFeatures:
          type: string
        sheds:
          type: boolean
        balcony:
          type: boolean
        mainRooms:
          type: integer
          format: int64
        style:
          type: string
        buildYear:
          type: integer
          format: int64
        buildType:
          type: string
        storeys:
          type: integer
          format: int64
        roofStyle:
          type: string
        nathersRating:
          type: number
          format: double
    SaleListingHistory:
      type: object
      properties:
        originalListingId:
          $ref: '#/components/schemas/ListingIdentifier'
        originalPrice:
          $ref: '#/components/schemas/SensitivePrice'
        originalPricePercentChange:
          $ref: '#/components/schemas/SensitiveChange'
        lastListingId:
          $ref: '#/components/schemas/ListingIdentifier'
        lastPrice:
          $ref: '#/components/schemas/SensitivePrice'
        lastPricePercentChange:
          $ref: '#/components/schemas/SensitiveChange'
        daysToSell:
          type: integer
          format: int64
x-refined-from:
- pricefinder-api-swagger.json
- pricefinder-api-swagger.yml