Overview of the WhenFresh API

Our API enables you to access billions of data points about the UK property market. It provides a unified way to navigate the geography of the UK, browse and purchase data points from many datasets, easily, quickly, and you only get charged for the exact data you want.

What can you do with the WhenFresh API?

You can use the WhenFresh API to build many user experiences related to the UK's property market.

  • Build a service to retrieve title information from an address when a customer's policy is up for renewal
  • Help your information workers view what data points are available for a customer, and purchase the ones they're interested in as part of an assessment
  • Pre-fill forms your customers fill-in about their property, and avoid the below-the-fold cliffhanger
  • Display a postcode-based address picker on your site

The UK landscape at your finger tips

Every home in the UK has a postal address. Be it to get a gas meter installed, receive a package from an online vendor, or get a quote for a home insurance, making sure we get the right address is essential.

On our hypermedia API, identifiers are always URIs, and any entity that has an identifier is a resource.

For example, you can get the URI for a postal address through a search by postcode, or by leveraging the data you already have from Royal Mail, Ordnance Survey, HM Land Registry or Register of Scotland.

It's not only postal addresses that have unique identifiers you can navigate to: ee also have first-class support for titles in England & Wales and Scotland, postcodes, and ordnance survey spatial addresses, with more to come.

And as this is a hypermedia API, you can navigate between resources.

Billions of data points

A key tenet of the WhenFresh API is that you can see exactly what data is avaialble for any of the resources on our systems, whatever the source.

Let's imagine you wanted to know how many bedrooms a dwelling has. By going to the Catalog Browser, you can navigate all the variable types avaible.

A variable type, just like in strongly-typed languages, gives some structural information about a datum, including the datum's value range: an integer, a monetary amount, etc. In our example above, the Bedroom Count variable type has a value range of integer.

Multiple datasets provide bedroom counts. Some datasets have a larger coverage, and not all are the same price. A variable type provided by a specific dataset is called a variable. Each has an identifier that you'll use to purchase data from us.

Millions of resources

You can purchase variables for different kind of resources, from postal addresses to postcodes.

Each resource has its own resource catalog, with which you'll be able to purchase variables you've selected, or browse the variables available in our datasets and interactively decide which ones you want.