ukhp_get {uklr}

Get House Price Data

Description

The UK House Price Index (UK HPI) captures changes in the value of residential properties. The UK HPI uses sales data collected on residential housing transactions, whether for cash or with a mortgage. Data is available at a national and regional level, as well as counties, local authorities and London boroughs.

Usage

ukhp_get(
  region = "england",
  item = "housePriceIndex",
  regexp = FALSE,
  start_date = NULL,
  end_date = NULL,
  ...
)

Arguments

region

the region to select. If regexp is set to FALSE then the matching should be exact, see ukhp_avail_regions for available regions. If regexp is set to TRUE then partial matching is possible. Furthermore if it is set to NULL then selects all available regions.

item

the item to select. See ukhp_avail_items for the available categories.

regexp

use regular expression in sparql to search for regions.

start_date

the start date as YYYY-MM-DD.

end_date

the end date as YYYY-MM-DD.

...

query modifiers passed through rdf_modifiers.

Details

Properties have been included:

• in England and Wales since January 1995

• in Scotland since January 2004

• in Northern Ireland since January 2005

Value

Returns a tibble in long format.

See Also

rdf_modifiers

Examples

# This is case sensitive
ukhp_get("england")

# However you can use regular expression instead of exact match
ukhp_get("england", regexp = TRUE)

# For all available items
ukhp_avail_items()

ukhp_get(c("england", "wales"), item = c("salesVolume", "housePriceIndexDetached"))