AutoComplete

Please read API Overview first

API Endpoint

The Autocomplete API endpoint won't change. It can be set as a constant.

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

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/autocomplete?key=YOUR_KEY
&address=YOUR_ADDRESS_OR_POSTCODE&addressProfileName=Demo5LineV2&vanityMode=true"<br>
		

• jQuery

$.ajax({
   type: "GET",
   dataType: "jsonp",
   url: "https://api.autoaddress.ie/2.0/autocomplete",
   data : {
       key: "YOUR_KEY",
       address: "YOUR_ADDRESS_OR_POSTCODE",
       addressProfileName: "Demo5LineV2",
       vanityMode: true
   },
   success: function(data){
       //do something with data
   }
});

• Angular JS

$http.jsonp('https://api.autoaddress.ie/2.0/autocomplete',{
   params: {
      key: "YOUR_KEY",
      address: "YOUR_ADDRESS_OR_POSTCODE",
      addressProfileName: "Demo5LineV2",
      vanityMode: true
   }
}).success(function(data){
   //do something with data
});

• Ruby

require 'json'
require 'net/http'

uri = URI.parse("https://api.autoaddress.ie/2.0/autocomplete?key=YOUR_KEY&address=YOUR_ADDRESS_OR_POSTCODE&addressProfileName=Demo5LineV2&vanityMode=true")
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/autocomplete?key=YOUR_KEY&address=YOUR_ADDRESS_OR_POSTCODE&addressProfileName=Demo5LineV2&vanityMode=true")
jsonResult = json.load(Response)

• C#

using System.IO;
using System.Net;

HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://api.autoaddress.ie/2.0/autocomplete?key=YOUR_KEY&address=YOUR_ADDRESS_OR_POSTCODE&addressProfileName=Demo5LineV2&vanityMode=true");
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 Autocomplete API call response may contain Options.  The Options consist of an array of addresses that match the input characters, together with a HATEOAS link. This allows interaction with the API solely through the hyperlinks we provide you.  As a developer you display the DisplayName to the user as a list. When the user selects an Option, retrieve the next href from that Option object and perform a GET request on that url which will make a call to the FindAddress API.
The following is a sample JSON response returned for a Autocomplete API request.

{
  "totalOptions": 1,
  "options": [
    {
      "displayName": "4 INNS COURT, WINETAVERN STREET, DUBLIN 8",
      "addressId": 1702105351,
      "addressType": {
        "code": 2100,
        "text": "NonResidentialAddressPoint"
      },
      "links": [
        {
          "rel": "next",
          "href": "https://api.autoaddress.ie/2.0/findaddress?key=YOUR_KEY&txn=4c43fa7d-6871-45f6-80cf-62f5034247cb&address=4%20INNS%20COURT%2C%20WINETAVERN%20STREET%2C%20DUBLIN%208&addressId=1702105351&limit=-1&vanityMode=True&addressElements=False&addressProfileName=Demo5LineV2"
        }
      ]
    }
  ],
  "input": {
    "key": "YOUR_KEY",
    "txn": "4c43fa7d-6871-45f6-80cf-62f5034247cb",
    "language": "en",
    "country": "ie",
    "limit": -1,
    "address": "4 inns co",
    "vanityMode": true,
    "addressElements": false,
    "addressProfileName: "Demo5LineV2"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://api.autoaddress.ie/2.0/autocomplete?key=YOUR_KEY&address=4+inns+co&language=en&vanityMode=True&addressElements=false&addressProfileName=Demo5LineV2"
    }
  ]
}

Input Fields

* Required Field

Output Fields

Option Object

Link Object