Get ECAD Data

Please read API Overview first

API Endpoint

The Get ECAD Data API endpoint won't change. It can be set as a constant.

https://api.autoaddress.ie/2.0/GetEcadData
	

N.B. This EndPoint URL resolves to a dynamic IP address, please be aware of this when making DNS and Firewall decisions.

Request

To search for a Postcode or Address, a simple  GET request from your desired language is all that is needed.

• cURL

curl -v "https://api.autoaddress.ie/2.0/GetEcadData?key=YOUR_KEY&ecadid=YOUR_ECAD_ID"
	

• jQuery

$.ajax({
   type: "GET",
   dataType: "jsonp",
   url: "https://api.autoaddress.ie/2.0/GetEcadData",
   data : {
       key: "YOUR_KEY",
       ecadid: "YOUR_ECAD_ID"
   },
   success: function(data){
       //do something with data
   }
});
	

• Angular JS

$http.jsonp('https://api.autoaddress.ie/2.0/GetEcadData',{
   params: {
      key: "YOUR_KEY",
      ecadid: "YOUR_ECAD_ID"
   }
}).success(function(data){
   //do something with data
});
	

• Ruby

require 'json'
require 'net/http'

uri = URI.parse("https://api.autoaddress.ie/2.0/GetEcadData?key=YOUR_KEY&ecadid=YOUR_ECAD_ID")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
response = http.get(uri.request_uri)
result = JSON.parse(response.body)
	

• Python

import json
import urllib2
 
Response = urllib2.urlopen ("https://api.autoaddress.ie/2.0/GetEcadData?key=YOUR_KEY&ecadid=YOUR_ECAD_ID")
jsonResult = json.load(Response)
	

• C#

using System.IO;
using System.Net;

HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://api.autoaddress.ie/2.0/GetEcadData?key=YOUR_KEY&ecadid=YOUR_ECAD_ID");
request.Method = WebRequestMethods.Http.Get;
request.Accept = "application/json";

using (HttpWebResponse response = request.GetResponse() as HttpWebResponse)
{
   var result = new StreamReader(response.GetResponseStream()).ReadToEnd();
}
			

Response

The following is a sample JSON response returned for a Get ECAD Data API request.

{
    "result": {
        "code": 100,
        "text": "EcadIdValid"
    },
    "ecadId": 1401182204,
    "ecadIdStatus": {
        "code": 100,
        "text": "Current"
    },
    "addressTypeId": 2230,
    "postalAddress": {
        "english": [
            "INNS COURT",
            "WINETAVERN STREET",
            "DUBLIN 8"
        ],
        "irish": [
            "INNS COURT",
            "SRÁID AN FHÍONA",
            "BAILE ÁTHA CLIATH 8"
        ]
    },
    "geographicAddress": {
        "english": [
            "INNS COURT",
            "WINETAVERN STREET",
            "DUBLIN 8"
        ],
        "irish": [
            "INNS COURT",
            "SRÁID AN FHÍONA",
            "BAILE ÁTHA CLIATH 8"
        ]
    },
    "administrativeInfo": {
        "ecadId": 1401182204,
        "release": "2015",
        "laId": 29,
        "dedId": 268098,
        "smallAreaId": 6349,
        "countyId": 1001000025,
        "gaeltacht": false
    },
    "buildingInfo": {
        "ecadId": 1401182204,
        "buildingTypeId": 2,
        "underConstruction": false,
        "buildingUse": "C",
        "vacant": false
    },
    "spatialInfo": {
        "ecadId": 1401182204,
        "ing": {
            "location": {
                "easting": 315130.94,
                "northing": 233997.19
            }
        },
        "itm": {
            "location": {
                "easting": 715056.72,
                "northing": 734023.49
            }
        },
        "etrs89": {
            "location": {
                "longitude": -6.272101,
                "latitude": 53.343913
            }
        },
        "spatialAccuracy": "3"
    },
    "relatedEcadIds": {
        "thoroughfareEcadIds": [
            1200016569
        ],
        "postTownEcadIds": [
            1100000007
        ],
        "postCountyEcadIds": [
            1001000025
        ],
        "geographicCountyEcadIds": [
            1001000025
        ]
    },
    "dateInfo": {
        "created": "2014-07-03T08:41:16.44Z",
        "modified": "2015-04-22T17:29:09.823Z"
    },
    "input": {
        "key": "YOUR_KEY",
        "txn": "d966bbb3-59e8-4f72-b061-452e559d393c",
        "ecadId": 1401182204,
        "history": false
    },
    "links": [
        {
            "rel": "self",
            "href": "https://api.autoaddress.ie/2.0/getecaddata?key=YOUR_KEY&ecadId=1401182204&history=false"
        }
    ]
}
	

Input Fields

* Required Field

Output Fields

eircodeInfo Object

administrativeInfo Object

buildingInfo Object

organisationInfo Object

spatialInfo Object

relatedEcadIds Object

dateInfo Object

Link Object