Find

A free string text search, intended to be an ambiguous/fuzzy search.

get

Authorizations

api-keyapi-key-headeroauth2

Query parameters

querystringrequired

Free text search parameter.

formatstring · enumoptional

The format the response will be returned in.

Available options:

maxresultsinteger · min: 1 · max: 100optional

The maximum number of results to return. Minimum = 1. Maximum = 100. Default = 100.

offsetinteger · min: 1optional

Offset the list of returned results by this amount.

boundsnumber[] · min: 4 · max: 4optional

Biases the results to a certain area. The is a British National Grid bounding box in the form: XMIN,YMIN,XMAX,YMAX

Example: [414000,114000,414100,114100]

fqstring · enumoptional

Filters the results by bounding box or local_type.

Example: ["&fq=BBOX:414000,114000,414100,114100","&fq=LOCAL_TYPE:City","&fq=LOCAL_TYPE:City LOCAL_TYPE:Bay"]Available options:

Responses

application/jsonapplication/xml

objectoptional

get

HTTPcURLJavaScriptPython

GET /search/names/v1/find HTTP/1.1
Host: api.os.uk
Accept: */*

200

Retrieves addresses based on a free text search.

{
  "header": {
    "uri": "text",
    "query": "text",
    "format": "text",
    "maxresults": 1,
    "offset": 1,
    "totalresults": 1
  },
  "results": [
    {
      "ID": 1,
      "NAMES_URI": "text",
      "NAME1": "text",
      "TYPE": "text",
      "LOCAL_TYPE": "text",
      "GEOMETRY_X": 1,
      "GEOMETRY_Y": 1,
      "MOST_DETAIL_VIEW_RES": 1,
      "LEAST_DETAIL_VIEW_RES": 1,
      "MBR_XMIN": 1,
      "MBR_YMIN": 1,
      "MBR_XMAX": 1,
      "MBR_YMAX": 1,
      "POSTCODE_DISTRICT": "text",
      "POSTCODE_DISTRICT_URI": "text",
      "POPULATED_PLACE": "text",
      "POPULATED_PLACE_URI": "text",
      "POPULATED_PLACE_TYPE": "text",
      "COUNTY_UNITARY": "text",
      "COUNTY_UNITARY_URI": "text",
      "COUNTY_UNITARY_TYPE": "text",
      "REGION": "text",
      "REGION_URI": "text",
      "COUNTRY": "text",
      "COUNTRY_URI": "text"
    }
  ]
}