Drilldown

Overview

The Drilldown endpoint is used to retrieve further addresses that are contained in an area such as a building or street.

Please read API Overview first.

API Endpoint

https://api.autoaddress.com/3.0/drilldown

Request

Please note: It is not possible to construct your own Drilldown requests.

Attempts to use a manually constructed Drilldown request will result in a HTTP error. 

Input Fields

NameTypeDescription
token*stringAccess token from Create Token endpoint
sig*stringSignature returned from previous API call
aa3id*stringAutoaddress ID for the Drilldown
address*stringAddress to search
countrystringCountry to limit results to
latitudestringLatitude to search at
longitudestringLongitude to search at
h3indexstringH3 index to search in
languagestringLanguage to return result in

* Required Field

The following is an example cURL Drilldown call.

curl --location 'https://api.autoaddress.com/3.0/drilldown?aa3Id=AA3_ID&address=YOUR_ADDRESS&token=YOUR_TOKEN&sig=SIGNATURE'\--header 'Accept-Language: en'<br>

Response

The following is a sample JSON response returned for a Drilldown API request.

{
    "type": "drilldown",
    "message": {
        "id": 3100,
        "language": "en",
        "value": "Select an option below"
    },
    "options": [
        {
            "value": "< DUBLIN AIRPORT BUSINESS PARK, SWORDS ROAD, DUBLIN 9",
            "link": {
                "rel": "autocomplete",
                "href": "https://api.autoaddress.com/3.0/autocomplete?address=Dublin&token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D",
                "title": "< DUBLIN AIRPORT BUSINESS PARK, SWORDS ROAD, DUBLIN 9"
            },
            "format": {
                "highlights": [
                    0,
                    1
                ],
                "lineBreaks": []
            },
            "suffix": ""
        },
        {
            "value": "BUSINESS NAMES A - Z",
            "link": {
                "rel": "drilldown",
                "href": "https://api.autoaddress.com/3.0/drilldown?aa3Id=IE05457e65-9978-458c-98a2-f3488f7232fa*1_Latn_en_V&address=Dublin&token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D&sig=591cb528d01778255aa430fae4540655",
                "title": "BUSINESS NAMES A - Z"
            },
            "format": {
                "highlights": [
                    0,
                    20
                ],
                "lineBreaks": []
            },
            "suffix": "8 Addresses"
        },
        {
            "value": "Dublin Airport Business Park, Swords Road, Dublin 9",
            "link": {
                "rel": "lookup",
                "href": "https://api.autoaddress.com/3.0/lookup?aa3Id=IE1900359573_Latn_en_V&token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D&sig=5d35f293bdcebb33298b44b3e95130af",
                "title": "Dublin Airport Business Park, Swords Road, Dublin 9"
            },
            "format": {
                "highlights": [
                    0,
                    28
                ],
                "lineBreaks": []
            },
            "suffix": ""
        },
        {
            "value": "TEMPLE RECRUITMENT, Unit 101A, Block A, Dublin Airport Business Park, Swords Road, Dublin 9",
            "link": {
                "rel": "lookup",
                "href": "https://api.autoaddress.com/3.0/lookup?aa3Id=IE1900166311_Latn_en_V&token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D&sig=8a5fce482b42382f65c301b64ce665b5",
                "title": "TEMPLE RECRUITMENT, Unit 101A, Block A, Dublin Airport Business Park, Swords Road, Dublin 9"
            },
            "format": {
                "highlights": [
                    19,
                    29
                ],
                "lineBreaks": [
                    18,
                    20
                ]
            },
            "suffix": ""
        },
        {
            "value": "CONGLOM INTERNATIONAL LIMITED, Unit 101B, Block A, Dublin Airport Business Park, Swords Road, Dublin 9",
            "link": {
                "rel": "lookup",
                "href": "https://api.autoaddress.com/3.0/lookup?aa3Id=IE1900334563_Latn_en_V&token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D&sig=6b1b3a3e69020434c2bc9d44ea410af2",
                "title": "CONGLOM INTERNATIONAL LIMITED, Unit 101B, Block A, Dublin Airport Business Park, Swords Road, Dublin 9"
            },
            "format": {
                "highlights": [
                    30,
                    40
                ],
                "lineBreaks": [
                    29,
                    31
                ]
            },
            "suffix": ""
        },
        {
            "value": "ZKTECO IRELAND LIMITED, Unit 102, Block A, Dublin Airport Business Park, Swords Road, Dublin 9",
            "link": {
                "rel": "lookup",
                "href": "https://api.autoaddress.com/3.0/lookup?aa3Id=IE1900166312_Latn_en_V&token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D&sig=b09f020b0741b178cdf691749b7c6c5f",
                "title": "ZKTECO IRELAND LIMITED, Unit 102, Block A, Dublin Airport Business Park, Swords Road, Dublin 9"
            },
            "format": {
                "highlights": [
                    23,
                    32
                ],
                "lineBreaks": [
                    22,
                    24
                ]
            },
            "suffix": ""
        },
        {
            "value": "TRAVEL MANAGEMENT INTERNATIONAL LIMITED, Unit 103/104, Block A, Dublin Airport Business Park, Swords Road, Dublin 9",
            "link": {
                "rel": "lookup",
                "href": "https://api.autoaddress.com/3.0/lookup?aa3Id=IE1900166313_Latn_en_V&token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D&sig=79023f65b6c1ceb00f169949d0fd2e92",
                "title": "TRAVEL MANAGEMENT INTERNATIONAL LIMITED, Unit 103/104, Block A, Dublin Airport Business Park, Swords Road, Dublin 9"
            },
            "format": {
                "highlights": [
                    40,
                    53
                ],
                "lineBreaks": [
                    39,
                    41
                ]
            },
            "suffix": ""
        },
        {
            "value": "FORWARD DESIGN COMPANY LIMITED, Unit 105, Block A, Dublin Airport Business Park, Swords Road, Dublin 9",
            "link": {
                "rel": "lookup",
                "href": "https://api.autoaddress.com/3.0/lookup?aa3Id=IE1900166314_Latn_en_V&token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D&sig=d5b6a7cda77da7b947a1ae149b81cf8e",
                "title": "FORWARD DESIGN COMPANY LIMITED, Unit 105, Block A, Dublin Airport Business Park, Swords Road, Dublin 9"
            },
            "format": {
                "highlights": [
                    31,
                    40
                ],
                "lineBreaks": [
                    30,
                    32
                ]
            },
            "suffix": ""
        },
        {
            "value": "GLOBAL FORWARDING, Unit 106, Block A, Dublin Airport Business Park, Swords Road, Dublin 9",
            "link": {
                "rel": "lookup",
                "href": "https://api.autoaddress.com/3.0/lookup?aa3Id=IE1900166315_Latn_en_V&token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D&sig=639ee6ca7fa798c4de3f4e160ce07b24",
                "title": "GLOBAL FORWARDING, Unit 106, Block A, Dublin Airport Business Park, Swords Road, Dublin 9"
            },
            "format": {
                "highlights": [
                    18,
                    27
                ],
                "lineBreaks": [
                    17,
                    19
                ]
            },
            "suffix": ""
        },
        {
            "value": "ARENA CAPITAL PARTNERS LIMITED, Unit 107, Block A, Dublin Airport Business Park, Swords Road, Dublin 9",
            "link": {
                "rel": "lookup",
                "href": "https://api.autoaddress.com/3.0/lookup?aa3Id=IE1900361007_Latn_en_V&token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D&sig=137d61852d8be82061b3db138bc769ca",
                "title": "ARENA CAPITAL PARTNERS LIMITED, Unit 107, Block A, Dublin Airport Business Park, Swords Road, Dublin 9"
            },
            "format": {
                "highlights": [
                    31,
                    40
                ],
                "lineBreaks": [
                    30,
                    32
                ]
            },
            "suffix": ""
        },
        {
            "value": "ARENA FINANCIAL SERVICES, Unit 108, Block A, Dublin Airport Business Park, Swords Road, Dublin 9",
            "link": {
                "rel": "lookup",
                "href": "https://api.autoaddress.com/3.0/lookup?aa3Id=IE1900166316_Latn_en_V&token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D&sig=3584a1a86c44a99f3161a000ae7ca671",
                "title": "ARENA FINANCIAL SERVICES, Unit 108, Block A, Dublin Airport Business Park, Swords Road, Dublin 9"
            },
            "format": {
                "highlights": [
                    25,
                    34
                ],
                "lineBreaks": [
                    24,
                    26
                ]
            },
            "suffix": ""
        },
        {
            "value": "Unit 109, Block A, Dublin Airport Business Park, Swords Road, Dublin 9",
            "link": {
                "rel": "lookup",
                "href": "https://api.autoaddress.com/3.0/lookup?aa3Id=IE1900166318_Latn_en_V&token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D&sig=c5ac4d1fcfc95ed68bad4f33af3eca5d",
                "title": "Unit 109, Block A, Dublin Airport Business Park, Swords Road, Dublin 9"
            },
            "format": {
                "highlights": [
                    0,
                    8
                ],
                "lineBreaks": []
            },
            "suffix": ""
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://api.autoaddress.com:443/3.0/drilldown?aa3Id=IE05457e65-9978-458c-98a2-f3488f7232fa_Latn_en_V&address=Dublin&sig=d9430edbe44c93053b3bd9c66712fe93&token=fvBby7sc9D+oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ+Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D",
            "title": "self"
        },
        {
            "rel": "autoaddressformlayout",
            "href": "https://api.autoaddress.com/3.0/autoaddressformlayout?token=fvBby7sc9D%20oGwJKa6f83sMca6oNynj2ehtH5P%2FmQpHfFpqemQ%20Ge17P1lVmboVXUauDn07Z8MjLx4%2FZBhW0wQ%3D%3D&sig=eef1cd3044a3f9b2b7187f78b6078972",
            "title": "Enter your address manually >"
        }
    ]
}

Output Fields

NameTypeDescription
typestringName of the response type
messageMessageA Message object (described below)
optionsOption[]An array of Option objects (described below)
linksLink[]An array of Link objects (described below)



Message Object

NameTypeDescription
idintMessage ID
languagestringLanguage of the message
valuestringValue of the message

Option Object

NameTypeDescription
valuestringDisplay name of the option
linkLinkA Link object (described below)
formatFormatFormatting instructions for autocomplete widget
suffixstringSuffix to be displayed after the options value

Link Object

NameTypeDescription
relstringType of link
hrefstringThe hyperlink the client should follow is stored in the value of this property
titlestringDisplay name of the link



Examples

jQuery

var settings = { "url": "https://api.autoaddress.com/3.0/drilldown?aa3Id=AA3_ID&address=YOUR_ADDRESS&token=YOUR_TOKEN&sig=SIGNATURE", 
"method": "GET", 
"timeout": 0, 
"headers": { 
	"Accept-Language": "en" }, 
};

$.ajax(settings).done(function (response) { 
	console.log(response); 
})

Ruby

require "uri"
require "net/http"

url = URI("https://api.autoaddress.com/3.0/drilldown?aa3Id=AA3_ID&address=YOUR_ADDRESS&token=YOUR_TOKEN&sig=SIGNATURE")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true


request = Net::HTTP::Get.new(url)
request["Accept-Language"] = "en"
request["User-Agent"] = "Ruby application" 


response = https.request(request)
puts response.read_body
<br>

Python

import requests


url = "https://api.autoaddress.com/3.0/drilldown?aa3Id=AA3_ID&address=YOUR_ADDRESS&token=YOUR_TOKEN&sig=SIGNATURE"


payload = {}
headers = {
  'Accept-Language': 'en'
  'User-Agent': 'Python application'
}


response = requests.request("GET", url, headers=headers, data=payload)


print(response.text)

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.autoaddress.com/3.0/drilldown?aa3Id=AA3_ID&address=YOUR_ADDRESS&token=YOUR_TOKEN&sig=SIGNATURE");
request.Headers.Add("Accept-Language", "en");
request.Headers.Add("User-Agent", ".NET application");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());