Loading...

Add Address

Adds addresses directly to your returned results.

Request

GET https://api.getAddress.io/private-address/{postcode}?api-key={admin-key}    
GET https://api.getAddress.io/private-address/{postcode}/{id}?api-key={admin-key}    
POST https://api.getAddress.io/private-address/{postcode}?api-key={admin-key}    
DELETE https://api.getAddress.io/private-address/{postcode}/{id}?api-key={admin-key}    
Examples

Lists addresses from your private address list.

Request

GET https://api.getAddress.io/private-address/TR19 7AA?api-key={admin-key}    

Response

[
    {
        "id": "1",
        "line1": "address line 1",
        "line2": "address line 2",
        "line3": "address line 3",
        "line4": "address line 4",
        "locality": "locality",
        "townOrCity": "town or city",
        "county": "county"
    },
    {
        "id": "2",
        "line1": "address line 1",
        "line2": "address line 2",
        "line3": "address line 3",
        "line4": "address line 4",
        "locality": "locality",
        "townOrCity": "town or city",
        "county": "county"
    }
]

Add an address to your private address list.

Request

POST https://api.getAddress.io/private-address/TR19 7AA?api-key={admin-key}    

Request Body

{
    "line1": "address line 1",
    "line2": "address line 2",
    "line3": "address line 3",
    "line4": "address line 4",
    "locality": "locality",
    "townOrCity": "town or city",
    "county": "county"
}

Response

{
    "message": "'TR19 7AA/1' has been added to your private address list.",
    "id": "1"
}
Top