AddressLookupService

<back to all web services

PostcodeLookupRequest

Postcode Lookup Requests

This RESTful API returns UK Address data in both POST and GET. Input=Postcode(Mandatory), HouseNameorNumber=(Optional). You must provide valid authentication to make a request.

Requires Authentication
The following routes are available for this service:
POST/addressCall to list addressesPOST request to search for addresses. Using Postcode and House Name/Number as input.
GET/address/{Postcode}Call to list addressesGET request to search for addresses. Using Token, Postcode and House Name/Number as input.
GET/address/{Postcode}/{HouseNo}Call to show a specific addressGET request to search for addresses. Using Token, Postcode and House Name/Number as input.
PostcodeLookupRequest Parameters:
NameParameterData TypeRequiredDescription
PostcodepathstringYesUsing a Postcode to return addresses.
HouseNopathstringNoOptional input value to limit the return data to a specific address.

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /address HTTP/1.1 
Host: webservices.mbukdatabase.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostcodeLookupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PostcodeLookupService.ServiceModel.Types">
  <HouseNo>String</HouseNo>
  <Postcode>String</Postcode>
</PostcodeLookupRequest>