create_search_url: Creates URLs for a Domain search

Description Usage Arguments Value

View source: R/create_search_url.R

Description

Creates URLs given parameters that is used when searching properties on domain.com.au. If the number of results exceeds a page, creates a vector of URLs that points to every results page.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
create_search_url(
  sale_type = c("rent", "sold-listings"),
  suburbs,
  beds = NULL,
  baths = NULL,
  price = NULL,
  exclude_houses = T,
  exclude = T,
 
    ua = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36"
)

Arguments

sale_type

'rent' to search for rentals or 'sold-listings' to search for recent sales.

suburbs

A vector of suburbs with the format 'suburb-name-state-postcode'.

beds

A (optional) 2-element vector of minimum and maximum bedrooms. c(NA, NA) means any number of bedrooms, c(1, 2) means 1-2 bedrooms and c(2, NA) means 2 or more bedrooms.

baths

A (optional) 2-element vector of minimum and maximum bathrooms with the same format as the number of bedrooms parameter.

price

A (optional) 2-element vector of minimum and maximum rents or prices with the same format as the number of bedrooms parameter. For rental searches, provide the rent per week, and for sold listings provide the sale price in dollars.

exclude_houses

If TRUE (default), excludes detached houses from the search results.

exclude

If TRUE (default), excludes properties with a deposit already taken from rental searches and excludes properites with price withheld from sales searches. If FALSE, includes all results.

ua

A valid user agent for rvest (optional).

Value

A vector of URLs.


aaronw22/domainR documentation built on Dec. 18, 2021, 9:27 p.m.