Skip to content

Latest commit

 

History

History
27 lines (14 loc) · 1.48 KB

readme.md

File metadata and controls

27 lines (14 loc) · 1.48 KB

ONS Address Index API Developers Guide

Introduction

The Office for National Statistics (ONS) Address Index API provides public sector organisations with address lookup functions, via HTTP. It allows users to look-up addresses in England and Wales, and to select and retrieve the official address.

The API is currently only available to a limited audience. Access can be requested by contacting Address Index

API access is restricted. API keys are required, and will be provided for those granted access.

This API is currently in Beta and still being developed. Please be aware that as a result there may occasionally be breaking changes as we enhance functionality and respond to feedback.

Getting data from ONS Address Index API

The Address Index API provides a number of end points to enable address look-up.

Each end point and its basic purpose are available from the Explore the API readme.

A full swagger definition is also provided.

Address Index Simple Tester

The Address Index Simple Tester allows users to use the various functions available via the API, providing an input request and receiving a response from the API.

Code Samples

A number of code samples are provided as a starting point for using the API