Skip to main content

Get Addresses by Postcode

This endpoint allows you to get addresses corresponding to a specified postcode

Get Addresses for a specific postcode using GET Request

{BASE_URL}/search/address/postcode

Example​

{BASE_URL}/search/address/SP6 3EP

URL Parameters​

ParameterTypeRequiredDescription
postcodestringyes*UK postcode being checked

Responses​

Success Example​

Status Code: 200

{
    "success": true,
    "data": {
        "addresses": [
            {
                "addressId": "Gold|A00007997291|ST|1",
                "BuildingNumber": "1",
                "County": "Hampshire",
                "DependentLocality": "Alderholt",
                "Postalcode": "SP6 3EP",
                "PostTown": "Fordingbridge",
                "ThoroughfareName": "Alder Drive",
                "UPRN": "100040690215",
                "Latitude": "50.9116160",
                "Longitude": "-1.8338930"
            },
            ...
        ]
    }
}

Validation Error Response​

Status Code: 200

{
    "success": false,
    "message": "Invalid postcode"
}

Error​

Status Code: 400

{

    "success": false,
    "message": "Message Returned"
}