Skip to content

Getting Started

This guide is provided to quickly demonstrate how to get started with the Zor API. There are several main components covered in this:

About Property Intelligence

The Zor API is designed for end-to-end heat pump installations. The API is powered by API’s knowledge of heating systems and our property intelligence algorithm, which allows you to get the suitability of any home for a heat pump in England, Scotland, and Wales.

For more details see Property Intelligence.

About Workflow

The workflow capabilities of the platform are configurable and span the whole lifecycle of jobs from initial homeowner interest to post installation, commissioning and monitoring.

For more details see API.

API Access

To access the API you will need a one-off setup, which will provide you with an API key to use.

Access to a sandbox environment will be provided upon request. Please contact your business representative to submit such request on your behalf.

API Usage

To use the API after acquiring an API key you can consult the API's OpenAPI

Authentication is on a per-request basis and requires providing the right API key for the environment you target (sandbox or production) via a header x-api-key

1st Call (UPRN only)

The simplest call you can make to the API is to retrieve an estimated for a property. This requires to merely provide a Unique Property Reference Number which provides a unique identifier for every spatial address in Great Britain. In the example below we are using the UPRN 100023336956 which corresponds to the address 10, Downing Street, London, SW1A 2AA.

{
  "uprn": "100023336956"
}

Using curl the same API call would look like:

curl  --location 'https://sandbox-api.heatgeek.com/uk/estimates' \
      --header 'x-api-key: **********************' \
      --header 'Content-Type: application/json' \
      --data '{
        "uprn": "100023336956"
      }'

Congratulations you have made your first API call!!

To try again using a different address you will need to convert such address to its UPRN.

Need help finding a UPRN?

There is a variety of tools you can use such as:

  • FindMyAddress, which can be useful for finding properties for testing purposes.
  • OS Places API is another tool that can be used to find UPRNs.

2nd Call (UPRN + property details)

Our property intelligence algorithm can work without any additional user input. However, the API allows additional details to be provided which can be used to refine the results. An example of an enriched call is shown below:

{
  "numberOfBedrooms": 0,
  "numberOfBathrooms": 0,
  "floorAreaSqm": 0,
  "propertyAgePeriod": "Pre-1900",
  "uprn": "100023336956"
}

Using curl the same API call would look like: 

curl    --location 'https://sandbox-api.heatgeek.com/uk/estimates' \
        --header 'x-api-key: ******************' \
        --header 'Content-Type: application/json' \
        --data '{
              "numberOfBedrooms": 0,
              "numberOfBathrooms": 0,
              "floorAreaSqm": 0,
              "propertyAgePeriod": "Pre-1900",
              "uprn": "100023336956"
          }'

Next Steps

Please refer to OpenAPI to explore the full capabilities of the API