Loading...

JavaScript - Autocomplete

Add as-you-type address completion to any HTML form. Try it

Example

Install from NPM or CDN

npm install getaddress-autocomplete

<script src="https://cdn.getaddress.io/scripts/getaddress-autocomplete-1.3.0.min.js"></script>

Usage

<label>First Address Line</label>
<input id="textbox_id" type="text"> 

<label>Second Address Line</label>
<input id="formatted_address_1" type="text">   

<label>Third Address Line</label>
<input id="formatted_address_2" type="text">  

<label>Town</label>
<input id="formatted_address_3" type="text">

<label>County</label>
<input id="formatted_address_4" type="text">

<label>Postcode</label>
<input id="postcode" type="text">

<script>
    getAddress.autocomplete(
        'textbox_id',
        'API Key or Domain Token' 
    );
</script>

Events

document.addEventListener("getaddress-autocomplete-suggestions", function(e){
    console.log(e.suggestions);
})

document.addEventListener("getaddress-autocomplete-suggestions-failed", function(e){
    console.log(e.status);
    console.log(e.message);
})

document.addEventListener("getaddress-autocomplete-address-selected", function(e){
    console.log(e.address);
})

document.addEventListener("getaddress-autocomplete-address-selected-failed", function(e){
    console.log(e.status);
    console.log(e.message);
})

Options

getAddress.autocomplete(
    'textbox_id',
    'API Key',
    /*options*/{
        output_fields:{
            formatted_address_0:'formatted_address_0',  /* The id of the element bound to 'formatted_address[0]' */
            formatted_address_1:'formatted_address_1',  /* The id of the element bound to 'formatted_address[1]' */
            formatted_address_2:'formatted_address_2',  /* The id of the element bound to 'formatted_address[2]' */
            formatted_address_3:'formatted_address_3',  /* The id of the element bound to 'formatted_address[3]' */
            formatted_address_4:'formatted_address_4',  /* The id of the element bound to 'formatted_address[4]' */
            line_1:'line_1',  /* The id of the element bound to 'line_1' */
            line_2:'line_2',  /* The id of the element bound to 'line_2' */
            line_3:'line_3',  /* The id of the element bound to 'line_3' */
            line_4:'line_4',  /* The id of the element bound to 'line_4' */
            latitude:'latitude',  /* The id of the element bound to 'latitude' */
            longitude:'longitude',  /* The id of the element bound to 'longitude' */
            town_or_city:'town_or_city',  /* The id of the element bound to 'town_or_city' */
            building_number:'building_number',  /* The id of the element bound to 'building_number' */
            building_name:'building_name',  /* The id of the element bound to 'building_name' */
            sub_building_number:'sub_building_number',  /* The id of the element bound to 'sub_building_number' */
            sub_building_name:'sub_building_name',  /* The id of the element bound to 'sub_building_name' */
            thoroughfare:'thoroughfare',  /* The id of the element bound to 'thoroughfare' */
            county:'county',  /* The id of the element bound to 'county' */
            country:'country',  /* The id of the element bound to 'country' */
            district:'district',  /* The id of the element bound to 'district' */
            locality:'locality',  /* The id of the element bound to 'locality' */
            postcode:'postcode',  /* The id of the element bound to 'postcode' */
            residential:'residential'  /* The id of the element bound to 'residential' */
        },
        id_prefix:'getAddress-autocomplete' ,  /* The id of the textbox and list container */
        css_prefix?:'getAddress_autocomplete'",  /* The class name prefix */
        delay:200, /* millisecond delay between keypress and API call */
        minimum_characters:2,  /* minimum characters to initiate an API call */
        clear_list_on_select:true, /* if true, clears list on suggestion selected */
        select_on_focus:true,  /* if true, highlights textbox characters on focus*/
        show_all_for_postcode:false, /* if true, shows all addresses for postcode*/
        show_all_for_postcode_text:'Show all..',  /* show all suggestion text*/
        alt_autocomplete_url:undefined,  /* alterative local autocomplete URL (when API key is not used) */
        alt_get_url:undefined,  /* alterative local get URL (when API key is not used) */
        input_class_names:[],  /* textbox class names */
        input_show_class_names:[],  /* textbox class names on show */
        list_class_names:[],  /* list class names */
        container_class_names:[], /* container class names */
        suggestion_class_names:[], /* suggestion class names */
        highlight_suggestion:true, /* if true, highlights matched suggestion text */
        highlight_suggestion_start_tag:'<b>',  /* highlighted suggestion text start tag */
        highlight_suggestion_end_tag:'</b>',  /* highlighted suggestion text end tag */
        list_width:undefined,   /* if true, set the list width */
        suggestion_count:6, /* number of retreived suggestions (max 20) */
        auto_calc_list_height:true,   /* if true, calculates the list's height */
        suggestion_template:undefined, /* the suggestion template (see Autocomplete API)*/
        filter:undefined, /* the suggestion filter (see Autocomplete API)*/
        bind_output_fields:true, /* if true, bind the output_fields to the address*/
        input_focus_on_select:true,  /* if true, sets the focus to the textbox after selecting an address*/
        debug:false, /* if true, logs behavior */
        enable_get:true /* if true, retreives address on select */
    }
);

Domain Tokens

To avoid exposing your API key in browser code, Domain Tokens can used in place of your API key.
Domain Tokens can be generated for a specific domain and it's sub-domains. They can also limit the number of look-ups per minute for an IP address. 

<script>
    getAddress.autocomplete
    (
        'textbox_id',
        'dtoken_hEDzcyiWMI1eXXXX'
    );
</script>
Top