OS Names API - Quick Search Configuration

WebMap supports the OS Names API which can be added to Quick Search. This provides an easy and current dataset for searching on postcodes, roads and place names for Great Britain.

How to add the OS Names API to Quick Search:

  1. Sign up for a free OS Names API key - https://osdatahub.os.uk/

  2. Select Searches > Add Search.

  3. Fill in the relevant fields and click Add.

Name

The name of the search, e.g. Street Search (OS Names)

Connector Type

OS Names

ZoomResolution

Pick a Resolution from the Resolutions menu (ensure it corresponds with the correct MapID).

Search Icon

Pick an icon from the menu. Related Topics Link IconRelated Topics

Easting Property

is the Easting property specified by the Ordnance Survey, set to X_COORDINATE

Northing Property

is the Northing property specified by the Ordnance Survey, set to Y_COORDINATE

Result Property

is the Result value from the Ordnance Survey, set to NAME1

API Key

is the Ordnance Survey API key value

Secondary Results

An example value is POPULATED_PLACE, which is likely to be the town or city name e.g. Cambridge

Results Delimiter

used to space results when a Secondary Results are used.

Values from the OS Names API must be upper case.