Full content is here: https://www.geoaddress-checked.ie/
The GeoDirectory API will allow you to integrate into your apps the capability to retrieve reliable and accurate address data from the GeoDirectory dataset, Ireland’s most authoritative electronic register of addresses matched precisely to their geographical location
In simplified terms, accessing the GeoDirectory API can be illustrated in this manner:
What can GeoDirectory API do?
Retrieve a list of addresses as ‘suggested matches’, that correspond to the user entered address or Eircode.
Retrieve additional address details for a previously established GeoDirectory address, such as Eircode or latitude and longitude.
A basic implementation of the GeoDirectory API would be a user input, e.g. a search, for entering a partial address and initiating a search, which would result in a list of suggestions to be displayed to the user, from which they could then select an address that met their requirement.
Depending on the implementation, the calls would be initiated repeatedly as the user types, or wait for the user to confirm their input.
Endpoints
API version: v1 v2
1. Retrieve a list of suggested addresses /search-address
Endpoint
https://www.geoaddress-checked.ie/api/v1/search-address
Request
token
required
authentication token received from GeoDirectory to be included in HTTP Authorization header
“Bearer ” + AUTH_TOKEN
q
required
string or eircode string to be included as request data parameter
INPUT_ADDRESS_OR_EIRCODE
e.g. ‘Cork City Council‘
Response sample
{
"results": [
{
"identification":"2704071036675511",
"addr_1":"CORK CITY COUNCIL",
"addr_2":"MOYCULLEN",
"addr_3":"STRAWHALL",
"addr_4":"FERMOY",
"addr_5":"CO. CORK",
"addr_6":"",
"addr_7":"",
"addr_8":"",
"addr_9":"",
"addr_10":"",
},
...other suggestions in the list in the same format
]
}
2. Retrieve address information /search-identification
Endpoint
https://www.geoaddress-checked.ie/api/v1/search-identification
Request
token
required
authentication token received from GeoDirectory to be included in HTTP Authorization header
“Bearer ” + AUTH_TOKEN
identification
required
string to be included as a data parameter
IDENTIFICATION
e.g. 2704071036675511
Response sample
{
"results":
{
"addr_1": "CORK COUNTY COUNCIL",
"addr_2": "UPLANDS RESERVOIR",
"addr_3": "STRAWHALL",
"addr_4": "FERMOY",
"addr_5": "CO. CORK",
"addr_6": "",
"addr_7": "",
"addr_8": "",
"addr_9": "",
"addr_10": "",
"eircode": "P61TP82",
"identification": "2704071036675511",
"itm_location": "581543.508876746,597888.619361642",
"location": "52.1325554504452,-8.26958504286015",
"nace_code": "O.84.11",
"nace_code_description": "GENERAL PUBLIC ADMINISTRATION ACTIVITIES",
"small_area": "47151015",
"unique": "TRUE",
"ed_name": "CARLOW URBAN",
"building_type": "DETACHED",
"building_derelict":"N",
"building_vacant":"N",
"building_invalid":"N",
"building_under_construction":"N",
"holiday_home":"N",
"demolished": "N"
}
}
HTTP response codes
Code
200
400
404
429
Summary
Success
Bad Request
An issue
Request URL does not exist
Too many requests. Wait a bit and try again.
Custom Error Codes
Code
400001
400002
400003
401001
401002
401003
401004
401005
401006
401007
429001
429002
429003
429004
Message
Invalid “q” parameter.
Invalid “identification” parameter.
Invalid “token” parameter.
Issue with token.
Token has expired.
Token has incorrect environment access.
Token has incorrect access.
Token has been blocked.
User account inactive.
No user credit remaining.
Token rate limit per second exceeded for hits.
Token rate limit per minute exceeded for hits.
Token rate limit per day exceeded for hits.
Token rate limit per minute exceeded for attempts.
Authentication Token
Accessing the API requires an authentication token to be included in the HTTP header of the query.
{ ‘authorization’: “Bearer ” + AUTH_TOKEN }
If you wish to give the GeoDirectory API a try, please register and contact us at info@geodirectory.ie . We will provide you with a token so you can access the address data and trial the API at a limited rate.
Once you are ready to use the API in its full capacity, please contact us to upgrade your account to a paid plan.
When registering for a token, please note that for the purpose of additional token security you may restrict your token to submitted URLs (e.g. if you are using the API from your own web application) and/or static IP addresses (e.g. if you are using the API from your own server or company VPN).
If you already have an account with active tokens, check your assigned tokens here:
https://www.geoaddress-checked.ie/api/v1/search-address
https://www.geoaddress-checked.ie/api/v1/search-identification
$.ajax({
type: "POST",
url: "https://www.geoaddress-checked.ie/api/v1/search-address",
data: JSON.stringify({
q: INPUT_ADDRESS_OR_EIRCODE
}),
headers: {
"content-type": "application/json",
"authorization": "Bearer " + AUTH_TOKEN
},
success: function(data) {
console.log(data.results);
}
});
curl -X POST -H "Authorization: Bearer AUTH_TOKEN" https://www.geoaddress-checked.ie/api/v1/search-address
-d q=INPUT_ADDRESS_OR_EIRCODE