openapi: 3.2.0
info:
  title: Domain Group Property Search 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 PropertySearch across 2 of this provider''s published API definitions: domain-group-openapi-latest.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: PropertySearch
paths:
  /v2/properties/search/radius/{searchType}:
    post:
      tags:
      - PropertySearch
      summary: Point Radius Search
      description: Make a search request to find properties within a point radius of a PropertyID, a GnafID, an Address, or a set of lat-lon coordinates. Only one of `propertyId`, `gnafId`, or `latitude` & `longitude`, or `address` should be provided.
      operationId: PropertySearch_ByRadius
      parameters:
      - name: searchType
        in: path
        description: Type of property search (sold, rent, or sale).
        required: true
        schema:
          enum:
          - sale
          - rent
          - sold
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
              - allOf:
                - $ref: '#/components/schemas/Property.Enrichment.v2.PointRadiusPropertyId'
                - $ref: '#/components/schemas/Property.Enrichment.v2.PointRadiusParams'
              - allOf:
                - $ref: '#/components/schemas/Property.Enrichment.v2.PointRadiusGnafId'
                - $ref: '#/components/schemas/Property.Enrichment.v2.PointRadiusParams'
              - allOf:
                - $ref: '#/components/schemas/Property.Enrichment.v2.PointRadiusLatLon'
                - $ref: '#/components/schemas/Property.Enrichment.v2.PointRadiusParams'
              - allOf:
                - $ref: '#/components/schemas/Property.Enrichment.v2.PropertyAddress-v2'
                - $ref: '#/components/schemas/Property.Enrichment.v2.PointRadiusParams'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                required:
                - items
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Property.Enrichment.v2.SearchItemOutput'
        '400':
          description: Bad request (likely missing required fields or incorrect parameters).
        '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: Any
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
components:
  schemas:
    Property.Enrichment.v2.PointRadiusGnafId:
      required:
      - gnafId
      type: object
      properties:
        gnafId:
          type: string
          description: Gnaf ID of property to use as the center of the search radius.
    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
    Property.Enrichment.v2.PointRadiusParams:
      type: object
      properties:
        radius:
          maximum: 50
          type: number
          description: Radius of the search in KM. Default is 5km.
          default: 5
        propertyType:
          enum:
          - House
          - Unit
          type: string
          description: Type of property.
        startDate:
          type: string
          description: Start date for filtering based on the date in YYYY-MM-DD format. Valid only for search type 'sold'.
          format: date
          example: '2024-08-22'
        endDate:
          type: string
          description: End date for filtering based on the date in YYYY-MM-DD format. Valid only for search type 'sold'.
          format: date
          example: '2024-08-22'
        priceMin:
          type: number
          description: Minimum price for the search.
        priceMax:
          type: number
          description: Maximum price for the search.
        bedroomMin:
          type: integer
          description: Minimum number of bedrooms.
        bedroomMax:
          type: integer
          description: Maximum number of bedrooms.
        bathroomMin:
          type: integer
          description: Minimum number of bathrooms.
        bathroomMax:
          type: integer
          description: Maximum number of bathrooms.
        carSpacesMin:
          type: integer
          description: Minimum number of car spaces.
        carSpacesMax:
          type: integer
          description: Maximum number of car spaces.
        landSizeMin:
          type: integer
          description: Minimum land size in square meters.
        landSizeMax:
          type: integer
          description: Maximum land size in square meters.
    Property.Enrichment.v2.ImageTypes:
      enum:
      - ListingPhoto
      - OldFloorPlanPhoto
      - NewFloorPlanPhoto
      - BuildingPhoto
      - NewDevelopmentLandPhoto
      - NewDevelopmentLumierePhoto
      - NewDevelopmentFeaturedPhoto
      - ConjunctionAgentLogo
      - NewDevelopmentRegionalPhoto
      - AdvertiserImage
      - YouWishClip
      - AgentCarousel
      - DevelopmentProjectGalleryPhoto
      - DevelopmentProjectAdvertisementPhoto
    Property.Enrichment.v2.PointRadiusPropertyId:
      required:
      - propertyId
      type: object
      properties:
        propertyId:
          type: string
          description: Property ID of property to use as the center of the search radius.
    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.PointRadiusLatLon:
      required:
      - latitude
      - longitude
      type: object
      properties:
        latitude:
          type: number
          description: latitude of the coordinates to use as the center of the search radius.
        longitude:
          type: number
          description: longitude of the coordinates to use as the center of the search radius.
    Property.Enrichment.v2.SearchItemOutput:
      type: object
      properties:
        propertyid:
          type: string
        listingid:
          type:
          - integer
          - 'null'
        addresscomponents:
          $ref: '#/components/schemas/Property.Enrichment.v2.AddressBasic'
        bedrooms:
          type:
          - integer
          - 'null'
        bathrooms:
          type:
          - integer
          - 'null'
        carspaces:
          type:
          - integer
          - 'null'
        landarea:
          type:
          - integer
          - 'null'
        images:
          type: array
          items:
            type: object
            properties:
              image_url:
                type: string
                description: URL of image source
              image_type:
                $ref: '#/components/schemas/Property.Enrichment.v2.ImageTypes'
        eventdate:
          type:
          - string
          - 'null'
          description: date of the event in YYYY-MM-DD format.
          format: date
          example: '2024-08-22'
        eventprice:
          type:
          - number
          - 'null'
        distance:
          type: number
  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-v2.json