API Demo

Give our API a spin below. These keys use our community key iddqd. Feel free to use your own and get in contact if you need a larger test balance.

Lookup a Postcode

Request a complete list of addresses given a postcode.

Find out more here.

Request Console

Query Parameters

Use Test Postcode

Use Test Key

URL

HTTP Response

Dispatch HTTP Request
Response Body
        
    
Response Status
        
    

Search for an Address

Return a list of complete addresses for a query string.

Note that including a (valid) postcode, will cause that search to be filtered by the postcode.

Find out more here.

Request Console

Query Parameters

Use Test Address

Use Test Key

URL

HTTP Response

Dispatch HTTP Request
Response Body
        
    
Response Status
        
    

Autcomplete an Address

Return a list of partial address suggestions for a query string.

Note that, in order to extract a full address, you will need to make a second request to the /udprn/:udprn endpoint using the code provided in the suggestion.

Find out more here.

Request Console

Query Parameters

Use Test Key

URL

HTTP Response

Dispatch HTTP Request
Response Body
        
    
Response Status
        
    

Retrieve an Address by its UDPRN

Returns a full address given its unique delivery point reference number (UDPRN).

This endpoint is typically used in conjunction with the autocomplete API.

Find out more here.

Request Console

Query Parameters

Use Test Key

URL

HTTP Response

Dispatch HTTP Request
Response Body
        
    
Response Status
        
    

Check for Key Usability

You can verify whether the key is in a usable state with the /keys/:key endpoint.

Request Console

Query Parameters

Use Test Key

URL

HTTP Response

Dispatch HTTP Request
Response Body
        
    
Response Status