openapi.yaml

openapi: 3.0.1
info:
  title: Australian Rent Search Plugin
  description: A plugin that allows the user to search for an ideal property to rent using ChatGPT.
  version: 'v1'
servers:
  - url: https://openai-ausrental-search.onrender.com
paths:
  /domain/:
    get:
      operationId: getRentalsUsingDomain
      summary: Get a list of available rentals in the area the user is searching using domain.com.au
      parameters:
        - in: query
          name: page
          schema:
            type: integer
          required: false
          description: Page of results to request. Starts at 1.
        - in: query
          name: suburb
          schema:
            type: string
          required: false
          description: Suburbs to search for rental properties, formatted as suburb-state-postcode, separated by commas. e.g. chatswood-nsw-2067,gordon-nsw-2072
        - in: query
          name: bedrooms
          schema:
            type: string
          required: false
          description: Number of bedrooms user is requesting. If user wants a minimum number of rooms, format it as a single number. e.g. 2. If user wants a range, format it as min-max. e.g. 2-4. "any" can be used in range values, but not by itself. e.g. 1-any
        - in: query
          name: price
          schema:
            type: string
          required: false
          description: Price range for an apartment. If user wants a maximum price, format it as an integer. e.g. 500. If user wants a range, format it as min-max. e.g. 200-500
        - in: query
          name: excludedeposittaken
          schema:
            type: integer
          required: false
          description: Exclude rental properties with deposits taken
        - in: query
          name: features
          schema:
            type: string
          required: false
          description: Features to search for, separated by commas. Options are petsallowed, gas, builtinwardrobes, gardencourtyard, internallaundry, furnished, balconydeck, study, swimmingpool, airconditioning, secureparking, ensuite, heating and dishwasher
        - in: query
          name: images
          schema:
            type: number
          required: false
          description: Set to 0 to disable image results or any other number to set how many images per result to return. Default value is 2
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getRentalsResponseDomain'
        "500":
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The reason the request was rejected.
  /rentdc/{suburbs}:
    get:
      operationId: getRentalsUsingRent
      summary: Get a list of available rentals in the area the user is searching using rent.com.au
      parameters:
        - in: path
          name: suburbs
          schema:
            type: string
          required: true
          description: Suburbs to search for rental properties, formatted as "suburb postcode", separated by commas. e.g. fairfield 2165,penrith 2750
        - in: query
          name: surrounding_suburbs
          schema:
            type: string
          required: false
          description: Set to 1 to include surrounding suburbs, or 0 to only use the exact suburbs entered
        - in: query
          name: rent_low
          schema:
            type: integer
          required: false
          description: Minimum price range for an apartment.
        - in: query
          name: rent_high
          schema:
            type: integer
          required: false
          description: Maximum price range for an apartment.
        - in: query
          name: page
          schema:
            type: integer
          required: false
          description: Page of results to request. Starts at 1
        - in: query
          name: bedrooms
          schema:
            type: integer
          required: false
          description: Minimum number of bedrooms user is requesting
        - in: query
          name: bathrooms
          schema:
            type: integer
          required: false
          description: Minimum number of bathrooms user is requesting
        - in: query
          name: car_spaces
          schema:
            type: integer
          required: false
          description: Minimum number of car spaces user is requesting
        - in: query
          name: walk_category
          schema:
            type: integer
          required: false
          description: Walk category user is requesting. 1 = Walker's Paradise, 2 = Very Walkable, 3 = Somewhat Walkable, 4 = Car Dependant
        - in: query
          name: nbn_category
          schema:
            type: integer
          required: false
          description: Whether NBN internet is required. 0 = Not Required, 1 = Required
        - in: query
          name: long_term_lease
          schema:
            type: integer
          required: false
          description: Whether user requires long term lease. 0 = Not Required, 1 = Required
        - in: query
          name: build_to_rent
          schema:
            type: integer
          required: false
          description: Whether user requires build to rent option. 0 = Not Required, 1 = Required
        - in: query
          name: images
          schema:
            type: integer
          required: false
          description: Set to 0 to disable image results or 1 to include image results. Default value is 1
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getRentalsResponseRent'
        "500":
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The reason the request was rejected
  /realestate/:
    get:
      operationId: getRentalsUsingRealestate
      summary: Get a list of available rentals in the area the user is searching using realestate.com.au
      parameters:
        - in: query
          name: channel
          schema:
            type: string
          required: true
          description: Set to rent or buy depending on whether user wants to search for rental properties or houses to buy. Default is rent
        - in: query
          name: propertyType
          schema:
            type: string
          required: true
          description: A type of property the user is looking for. Options are house, apartment, townhouse, villa, unit or all. Default is all
        - in: query
          name: searchLocation
          schema:
            type: string
          required: true
          description: Location user is searching for properties in. Can be suburb, postcode, state or any combination separated by commas. Default is "Penrith, NSW"
        - in: query
          name: minBedrooms
          schema:
            type: number
          required: false
          description: Minimum number of bedrooms user is searching for
        - in: query
          name: minBathrooms
          schema:
            type: number
          required: false
          description: Minimum number of bathrooms user is searching for
        - in: query
          name: minParkingSpaces
          schema:
            type: number
          required: false
          description: Minimum number of parking spaces user is searching for
        - in: query
          name: pageSize
          schema:
            type: number
          required: false
          description: How many listings per page user is requesting. Default is 20
        - in: query
          name: page
          schema:
            type: number
          required: false
          description: What page number user is requesting. Default is 1
        - in: query
          name: minimumPrice
          schema:
            type: number
          required: false
          description: Minimum price of the property. Default is 200
        - in: query
          name: maximumPrice
          schema:
            type: number
          required: false
          description: Maximum price of the property. Default is 600
        - in: query
          name: surroundingSuburbs
          schema:
            type: boolean
          required: false
          description: Whether to search for surrounding suburbs. Default is true
        - in: query
          name: furnished
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that are furnished. Default is false
        - in: query
          name: petsAllowed
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that allow pets. Default is false
        - in: query
          name: swimmingPool
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have swimming pools. Default is false
        - in: query
          name: garage
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have a garage. Default is false
        - in: query
          name: balcony
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have a balcony. Default is false
        - in: query
          name: outdoorArea
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have an outdoor area. Default is false
        - in: query
          name: ensuite
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have an ensuite. Default is false
        - in: query
          name: dishwasher
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have a dishwasher. Default is false
        - in: query
          name: study
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have a study. Default is false
        - in: query
          name: builtInRobes
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have built in wardrobes. Default is false
        - in: query
          name: airConditioning
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have air conditioning. Default is false
        - in: query
          name: solarPanels
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have a solar panels. Default is false
        - in: query
          name: heating
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have heating. Default is false
        - in: query
          name: highEnergyEfficiency
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have high energy efficiency. Default is false
        - in: query
          name: waterTank
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have a water tank. Default is false
        - in: query
          name: solarHotWater
          schema:
            type: boolean
          required: false
          description: Whether to only include listings that have solar hot water. Default is false
        - in: query
          name: images
          schema:
            type: integer
          required: false
          description: Set to 0 to disable image results or any other number to set how many images per result to return. Default value is 2
        - in: query
          name: descriptionLength
          schema:
            type: integer
          required: false
          description: Set to 0 to disable desciption results or any other number to set the amount of characters to trim the description down to. Default value is 200
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getRentalsResponseRealestate'
        "500":
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The reason the request was rejected
  /flatmates:
    get:
      operationId: getRentalsUsingFlatmates
      summary: Get a list of available rentals in the area the user is searching using flatmates.com.au
      parameters:
        - in: query
          name: locations
          schema:
            type: string
          required: false
          description: Locations required, formatted as suburb-postcode. Extras added with a + in between. e.g. "penrith-2750+parramatta-2150"
        - in: query
          name: page
          schema:
            type: string
          required: false
          description: page number to request
        - in: query
          name: bathroomType
          schema:
            type: string
          required: false
          description: Type of bathroom required. Options are "ensuite-or-own" or "ensuite"
        - in: query
          name: furnishings
          schema:
            type: string
          required: false
          description: Furnishings required. Options are "furnished" or "unfurnished"
        - in: query
          name: parking
          schema:
            type: string
          required: false
          description: Parking requirements. Options are "off-street-parking", "on-street-parking" or "no-parking"
        - in: query
          name: gender
          schema:
            type: string
          required: false
          description: Gender preference required. Options are "males", "females" or "couples"
        - in: query
          name: allFemale
          schema:
            type: boolean
          required: false
          description: Whether all female tenants are required
        - in: query
          name: lengthOfStay
          schema:
            type: string
          required: false
          description: Desired length of stay in weeks, months or years. e.g. "1 year"
        - in: query
          name: lgbtFriendly
          schema:
            type: boolean
          required: false
          description: Whether LGBT-friendly tenants are required
        - in: query
          name: retirees
          schema:
            type: boolean
          required: false
          description: Whether the property is suitable for retirees
        - in: query
          name: students
          schema:
            type: boolean
          required: false
          description: Whether the property is suitable for students
        - in: query
          name: smokers
          schema:
            type: boolean
          required: false
          description: Whether the property allows smoking
        - in: query
          name: backpackers
          schema:
            type: boolean
          required: false
          description: Whether the property is suitable for backpackers
        - in: query
          name: children
          schema:
            type: boolean
          required: false
          description: Whether the property is suitable for children
        - in: query
          name: over40
          schema:
            type: boolean
          required: false
          description: Whether the property is suitable for people over 40
        - in: query
          name: pets
          schema:
            type: boolean
          required: false
          description: Whether the property allows pets
        - in: query
          name: numberOfRooms
          schema:
            type: string
          required: false
          description: The number of rooms required
        - in: query
          name: room
          schema:
            type: string
          required: false
          description: The type of room. Options are private-room and shared-room
        - in: query
          name: shareHouses
          schema:
            type: boolean
          required: false
          description: Whether to include share houses in the listings
        - in: query
          name: dateAvailable
          schema:
            type: string
          required: false
          description: Date the rental property is available, formatted as day-month-year. e.g. "03-06-2023"
        - in: query
          name: minBudget
          schema:
            type: string
          required: false
          description: Minimum price for the property
        - in: query
          name: maxBudget
          schema:
            type: string
          required: false
          description: Maximum price for the property
        - in: query
          name: billsIncluded
          schema:
            type: boolean
          required: false
          description: Whether bills are included in the price
        - in: query
          name: keywordInput
          schema:
            type: string
          required: false
          description: Keywords to search in listing descriptions
        - in: query
          name: wholeProperties
          schema:
            type: boolean
          required: false
          description: Whether to include whole properties
        - in: query
          name: studios
          schema:
            type: boolean
          required: false
          description: Whether to include studios
        - in: query
          name: grannyFlats
          schema:
            type: boolean
          required: false
          description: Whether to include granny flats
        - in: query
          name: studentAccommodation
          schema:
            type: boolean
          required: false
          description: Whether to include student accommodations
        - in: query
          name: homestays
          schema:
            type: boolean
          required: false
          description: Whether to include homestays
        - in: query
          name: images
          schema:
            type: integer
          required: false
          description: Set to 0 to disable image results or any other number to set how many images per result to return. Default value is 2
        - in: query
          name: descriptionLength
          schema:
            type: integer
          required: false
          description: Set to 0 to disable desciption results or any other number to set the amount of characters to trim the description down to. Default value is 200
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getRentalsResponseFlatmates'
        "500":
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The reason the request was rejected
components:
  schemas:
    getRentalsResponseDomain:
      type: object
      properties:
        totalPages:
          type: number
          description: Total number of pages to use for pagination.
        page:
          type: number
          description: Current page number to use for pagination.
        listingsPerPage:
          type: number
          description: Number of current listing results per page to use for pagination.
        totalListings:
          type: number
          description: Total number of property listings to use for pagination.
        listings:
          type: object
          additionalProperties:
            type: object
            properties:
              listingModel:
                type: object
                properties:
                  address:
                    type: string
                  images:
                    type: array
                    items:
                      type: string
                    description: Image urls to be displayed as images in the chat.
                  features:
                    type: object
                    properties:
                      baths:
                        type: number
                      beds:
                        type: number
                      landsize:
                        type: number
                      landUnit:
                        type: string
                      propertyTypeFormatted:
                        type: string
                  url:
                    type: string
                    description: URL to the property listing. Start with the root server www.domain.com.au followed by this url.
                  price:
                    type: string
                  inspection:
                    type: object
                    properties:
                      openTime:
                        type: string
                      closeTime:
                        type: string
    getRentalsResponseRent:
      type: object
      properties:
        totalListings:
          type: number
          description: Total number of property listings to use for pagination. You can also use this to work out how many more pages there are to navigate through by dividing the totalListings number by 20 (the number of listings per page)
        nextPageNum:
          type: number
          description: The next page number to navigate to
        currentPageNum:
          type: number
          description: The current page number
        listings:
          type: array
          items:
            type: object
            properties:
              address:
                type: string
              imageUrl:
                type: string
                description: URL of the image to be displayed in chat
              price:
                type: string
              features:
                type: array
                items:
                  type: string
                description: List of features the property has
              propType:
                type: string
                description: Property type
              description:
                type: string
                description: Description of the property listing
              url:
                type: string
                description: URL of the property listing
    getRentalsResponseRealestate:
      type: object
      properties:
        totalListings:
          type: number
          description: Total number of property listings. You can also use this to work out how many more pages there are to navigate through by dividing the totalListings number by the number of listings per page
        currentPage:
          type: number
          description: The current page number
        pageSize:
          type: number
          description: The number of listings per page
        listings:
          type: array
          items:
            type: object
            properties:
              images:
                type: array
                items:
                  type: string
              prettyUrl:
                type: string
                description: url of the listing. prepend this url with "https://www.realestate.com.au/"
              description:
                type: string
              price:
                type: string
                description: price of the listing. pw means per week
              propertyType:
                type: string
              nextInspectionTime:
                type: object
                properties:
                  startTime:
                    type: string
                  endTime:
                    type: string
              address:
                type: string
              propertyFeatures:
                type: array
                items:
                  type: string
              bond:
                type: string
              dateAvailable:
                type: string
    getRentalsResponseFlatmates:
      type: object
      properties:
        nextPage:
          type: number
          description: The next page number for pagination
        listings:
          type: array
          items:
            type: object
            properties:
              url:
                type: string
                description: URL to the property listing. Start with the root server flatmates.com.au/ followed by this url.
              images:
                type: array
                items:
                  type: string
              price:
                type: string
              billsIncluded:
                type: boolean
              bedrooms:
                type: number
              bathrooms:
                type: number
              occupants:
                type: number
              address:
                type: string
              rooms:
                type: string
              description:
                type: string