Loading...

Private Addresses

Private addresses can be added directly to your search results.

Request

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

Gets an address from your private address list.

Request

GET https://api.getAddress.io/v2/private-address/{id}?api-key={admin-key}

Response

{
    'id':'pa_xxx',
    'postcode':'RM3 7XL',
    'latitude':51.60865020751953,
    'longitude':-0.891636312007904,
    'thoroughfare':'Northallerton Way',
    'building_name':'Alcester House',
    'sub_building_name':'',
    'sub_building_number': '',
    'building_number': '88',
    'line_1':'3 Alcester House',
    'line_2':'Northallerton Way',
    'line_3':'',
    'line_4':'',
    'locality':'',
    'town_or_city':'Romford',
    'county':'Essex',
    'district':'Havering',
    'country':'England'
    'residential':true
}

Lists all addresses from your private address list.

Request

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

Response

[
    {
        'id':'pa_xxx',
        'postcode':'RM3 7XL',
        'latitude':51.60865020751953,
        'longitude':-0.891636312007904,
        'thoroughfare':'Northallerton Way',
        'building_name':'Alcester House',
        'sub_building_name':'',
        'sub_building_number': '',
        'building_number': '88',
        'line_1':'3 Alcester House',
        'line_2':'Northallerton Way',
        'line_3':'',
        'line_4':'',
        'locality':'',
        'town_or_city':'Romford',
        'county':'Essex',
        'district':'Havering',
        'country':'England'
        'residential':true
    },
    {
        'id':'pa_yyy',
        'postcode':'RM3 0DJ',
        'latitude':51.60865020751953,
        'longitude':-0.891636312007904,
        'thoroughfare':'Rosslyn Avenue',
        'building_name':'',
        'sub_building_name':'',
        'sub_building_number': '',
        'building_number': '188',
        'line_1':'188 Rosslyn Avenue',
        'line_2':'',
        'line_3':'',
        'line_4':'',
        'locality':'',
        'town_or_city':'Romford',
        'county':'Essex',
        'district':'Havering',
        'country':'England'
        'residential':true
    }
]

Add an address to your private address list.

Request

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

Request Body

{
    'postcode':'{the postcode}',
    'residential': {true/false},
    'line_1': '{addres line 1}',
    'line_2': '{address line 2}', /*optional*/
    'line_3': '{address line 3}', /*optional*/
    'line_4': '{address line 4}', /*optional*/
    'locality': '{locality}', /*optional*/
    'town_or_city': '{town_or_city}', /*optional*/
    'county': '{county}' /*optional*/ 
}

Response

{
    'message': 'Private address added.'
    'id': 'pa_xxx'
}

Deletes an address from your private address list.

Request

DELETE https://api.getAddress.io/v2/private-address/{id}?api-key={admin-key}

Response

{
    'message': 'pa_xxx' has been removed from your private address list.'
}
Top