Vepler API Documentation

The Vepler API serves UK property data over HTTPS. Responses are JSON, apart from map tiles, census CSV files and title document PDFs.

Base URL: https://api.vepler.com. Every endpoint is under /v1.
Authentication: your API key in the x-api-key header. See Authentication.
Billing: most requests are charged in credits against your account. The pricing page in your dashboard lists the price of each product.

What’s available

The names below match the sections of the API reference, which documents every endpoint, parameter and response field. Addresses and search

Section	What you get
Address	Addresses by postcode or UPRN, resolution of free-text addresses to UPRNs, reverse geocoding from a coordinate, and bulk cleansing.
Search	One autocomplete endpoint across properties, addresses, streets and places.
Streets	Streets by USRN, UPRN, coordinate, name or postcode, with their names, places and a representative point, and on request the properties on each and their count.

Properties and land

Section	What you get
Property	Property records keyed by UPRN: characteristics, tenure, market status, pricing and ownership. One property, a batch or a whole area.
AVM	Automated valuations. Each estimate comes with a confidence interval.
Listings	Properties advertised for sale or to rent, with asking price, marketing status, description, features and media.
Transactions	Sold prices from HM Land Registry price paid data, by area or by UPRN.
EPC	Energy Performance Certificates: current and potential ratings, fabric and heating, recommendations and running costs.
Buildings	Building footprints and attributes, by building, UPRN, area or point.
Sites	Registered land titles and their boundaries, by area or by property.
Title Deeds	Official copies of title documents, bought per title, with structured detail extracted from them.

Planning and designations

Section	What you get
Planning	Planning applications with status, development type, decision dates and documents.
Heritage	Scheduled monuments, world heritage sites, registered battlefields and protected wreck sites.
Conservation	Special Areas of Conservation, Special Protection Areas, Ramsar wetlands, ancient and native woodland, and landscape designations.
Land Constraint	Green Belt, Tree Preservation Zones, Article 4 Direction Areas, Agricultural Land Classification, Flood Zones 2 and 3, and Coal Mining Development High Risk Areas.
Flood Risk	Flood risk at a coordinate, per source, with the datasets behind it.

Areas and neighbourhoods

Section	What you get
Areas	Administrative and statistical areas with boundaries and hierarchies, and the areas that contain a point or postcode.
Geography	Areas by GSS code in one versioned tree: what contains an area, what it contains, and where each record came from.
Census	Census datasets and variables, area profiles, totals for custom areas, and map tiles.
Metrics	Demographic, economic and housing statistics, comparable across areas of the same type.
Prosperity	The Prosperity Index for small areas.
Safety	Recorded crime and antisocial behaviour by neighbourhood, with counts by category and period, and scores.
Schools, Schools Catchment, Schools Reference	Schools with inspection outcomes, performance, intake and capacity, plus catchment areas and admission areas.
POI	Amenities, facilities, transport and services near a location.
Connectivity	Broadband and mobile coverage at a location.
Air Quality	Modelled pollutant concentrations and air quality bands at a location.
Energy	Electricity network substations with capacity and headroom, supply areas, connection queues and forecasts.
Councils	Local authorities with contact details and service links.
Companies	Companies House companies, officers and people with significant control.

System holds a health check for each service. Your account may not include every product. A request to a product it does not include returns 403.

Versions

New releases ship often, all under /v1, and each has a version number. See Versions for what changes between releases and how to follow them.

Tools

API reference: every endpoint, with a console for test requests.
OpenAPI document: the full specification as JSON, to generate a client in any language.
TypeScript SDK: @vepler/sdk on npm.
Changelog: customer-facing changes, release by release.

Questions: hello@vepler.com.

Getting Started

Concepts

Introduction

What’s available

Versions

Tools

​What’s available

​Versions

​Tools

What’s available

Versions

Tools