Skip to content

Latest commit

 

History

History
187 lines (179 loc) · 6.39 KB

File metadata and controls

187 lines (179 loc) · 6.39 KB

Explore the API

The ONS Address Index API lets you retrieve the official version of addresses in England and Wales. The data is currently updated on a 6 week rolling basis.

Principle Endpoints

Method Endpoint Description
GET /addresses Search for an address.
GET /addresses/partial Search by partial address (for type ahead).
GET /addresses/postcode/{postcode} Search for an address by postcode.
GET /addresses/groupedpostcode/{postcode} Search for postcodes matching a part postcode pattern.
GET /addresses/random Search for a random address.
GET /addresses/uprn/{uprn} Gets an address by UPRN.
POST /addresses/multiuprn Gets addresses from an array of UPRNs.
POST /bulk Runs a batch of up to 30000 addresses.

Custom Endpoints

Method Endpoint Description
GET /addresses/ids Custom endpoint for Integrated Data Service.
GET /addresses/eq Custom endpoint for Electronic Questionnaire.
GET /addresses/eq/uprn/{uprn} Gets an address by UPRN (EQ version).
GET /addresses/rh/partial Search by partial address for type ahead (RH Version).
GET /addresses/rh/postcode/{postcode} Search for an address by postcode (RH version).
GET /addresses/rh/uprn/{uprn} Gets an address by UPRN (RH version).

Supplementary Endpoints

Method Endpoint Description
GET /classifications Return a list of available classification codes
GET /codelists Return a list of codelists supported by the API
GET /custodians Return a list of available local custodian codes
GET /logicalstatuses Return a list of available logical status values
GET /sources Return a list of available external source codes
GET /version Get version information.
GET /epochs Get list of available epochs.