# House price index for Wales, Scotland and Northern Ireland

**Use case:** 

Twelve months of official UK House Price Index figures for Wales, Scotland and Northern Ireland: average price by property type, index and change.

## Input

```json
{
  "areas": [
    "wales",
    "scotland",
    "northern-ireland"
  ],
  "monthsBack": 12
}
```

## Output

```json
{
  "area": {
    "label": "Area slug",
    "format": "text"
  },
  "areaLabel": {
    "label": "Area",
    "format": "text"
  },
  "refMonth": {
    "label": "Month",
    "format": "text"
  },
  "averagePrice": {
    "label": "Average price (GBP)",
    "format": "number"
  },
  "housePriceIndex": {
    "label": "House price index",
    "format": "number"
  },
  "percentageChange": {
    "label": "Change vs. prev. month (%)",
    "format": "number"
  },
  "percentageAnnualChange": {
    "label": "Change vs. prev. year (%)",
    "format": "number"
  },
  "salesVolume": {
    "label": "Sales volume",
    "format": "number"
  }
}
```

## How it works

### 1. Sign up on Apify or log in

The UK House Price Index API: Average Prices by Area Actor is ready to run with the inputs already set for "House price index for Wales, Scotland and Northern Ireland". [Sign up or log in](https://console.apify.com/create-task-from-example/qpyl1aDBdYdZkUoRF) and you'll land in Apify Console with a copy of this exact task.

### 2. Start the "House price index for Wales, Scotland and Northern Ireland" task

The UK House Price Index API: Average Prices by Area Actor will start running based on the input automatically. You can also change all the input fields, like areas (region or local authority slugs) and months of history per area, to match your specific use case.

### 3. Receive the "House price index for Wales, Scotland and Northern Ireland" output

Monitor the progress in real time. You will be notified as soon as your dataset is complete and ready for review. Each result includes data such as area slug, area, month, and more.

### 4. Integrate into your workflow

The final output is delivered in JSON, CSV, or Excel format, ready to be plugged into your workflow. You can also [run the "House price index for Wales, Scotland and Northern Ireland" task via API](https://apify.com/tabulary/uk-house-price-index-stats.md).

## About this Actor

This example demonstrates how to use [UK House Price Index API: Average Prices by Area](https://apify.com/tabulary/uk-house-price-index-stats.md) with a specific input configuration. Visit the [Actor detail page](https://apify.com/tabulary/uk-house-price-index-stats.md) to learn more, explore other use cases, and run it yourself.


## How to integrate an Actor?

This Task's input is already configured above. Use it as-is rather than inventing a new one.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For full API examples (JavaScript, Python, CLI, MCP, OpenAPI), see this Task's Actor page: https://apify.com/tabulary/uk-house-price-index-stats.md

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).