> For the complete documentation index, see [llms.txt](https://ieg4.gitbook.io/edesigner-new/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ieg4.gitbook.io/edesigner-new/no-code-integrations/address-look-ups/ordnance-survey.md). # Ordnance Survey In early 2021, Councils became able to use the Ordnance Survey APIs to search for addresses at no cost. These APIs are documented here: {% embed url="" %} OS Data Hub {% endembed %} 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. ![](/files/2nKrvI6BOAqDkwxTt6T8) 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. {% hint style="info" %} ### May 2026 Update From version 2.20 additional configuration has now been added to allow Ordnance Survey address look up Sections to be marked as Read only and Mandatory. When you tick to mark an address look up as Read only you are also then able to select Mandatory address look up. {% endhint %}
### Filtered address look ups Different address lookup providers can be configured using Ordnance Survey to support council specific and global address filters. In the example above an address provider called Ordnance Survey - Charnwood Only has been configured to filter addresses within Charnwood Borough Council only. This is achieved using the Council filter provided as part of the OS Places data set. ### Address Lookup Style There is a setting that controls the style of the address look up. The setting is: **CustomAddressProviders** The two modes available are: * **TypeAheadSearch** (this is the default) - set the value within the setting config to "Style":0 i.e. \[ { "Enabled":true, "Name":"Ordnance Survey", "Type":"API KEY", "Style":0 } ] If this option is enabled, as the user types in an address or postcode, it will instantly start searching for addresses. ![Type Ahead Address Search](/files/M9kWcu2U02JyEpEzuBZT) This provides a smart way of dynamically getting the results as the user enters their address. {% hint style="info" %} 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. {% endhint %} * **Postcode** set the value in the setting config to "Style":1 If this option is selected the customer needs to enter a postcode and then physically click a search button. {% hint style="success" %} We'd recommend using this method. {% endhint %} ![Postcode style Address Search](/files/4jaFzwAK470JEPi58bFO) ### 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: {% hint style="info" %} **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**](https://osdatahub.os.uk/) {% endhint %} \ .Once you have this simply provide the details to IEG4 support: {% embed url="" %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://ieg4.gitbook.io/edesigner-new/no-code-integrations/address-look-ups/ordnance-survey.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.