Ordnance Survey - Places API

In early 2021, Councils became able to use the Ordnance Survey APIs to search for addresses at no cost.

These APIs are documented here:

OS Data Hub

OS Data Hub

Reflective of this, IEG4 has created a no code address look up function that is fully integrated to these APIs and this enables non-technical staff to add an address look up to all of their forms.

To add the address look up it's as easy as adding a section and selecting the address selection per below:

Address Section

The ability to place an address search into forms that is able to search the entirety of the UK:

The default option, now that it is free to councils is 'Ordnance Survey'.

Simply click to save and you've set up an address section, which is capable of integrating with the Ordnance Survey.

Address Lookup Style

There is a setting that controls the style of the address look up. The setting is:

AddressLookupStyle

The two modes available which needs you to set them as the value for the above setting.

• TypeAheadSearch (this is the default)

If this option is enabled, as the user types in an address or postcode, it will instantly start searching for addresses.

This provides a smart way of dynamically getting the results as the user enters their address.

The speed of the API can mean that sometimes it takes a while for the results to refresh and so if you find this, we'd suggest using the 'Postcode' method.

• Postcode

If this option is selected the customer needs to enter a postcode and then physically click a search button.

We'd recommend using this method.

Notes

If the setting is not present, you simply need to use the Create button at the bottom of the Form Management > Settings page to add it and set its value to your preferred style.

This can be added at either form level or at global level (not form specific) in your form settings.

Prerequisite

In order that this can be set up by the IEG4 team, we need to have the council's API key for this. This is free to councils now and simply needs you to create an account per below:

If you are a Public Sector Geospatial Agreement (PSGA) member you can access and use the OS Places API (excluding Match & Cleanse) for free via the OS DataHub. Register for an account or login at www.osdatahub.os.uk

.Once you have this simply provide the details to IEG4 support:

IEG4