Find

API test authentication

The Open API block allows you to test OS APIs directly from the page with example data and parameters. To use this feature, you will need to add your API Key or OAuth2 token to the authentication field.

For help generating an API Key or OAuth2 token, please see the Getting started with an API project or OAuth2 documentation.

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

get

Authorizations

api-key & api-key-header & oauth2

keystringRequired

keystringRequired

OAuth2clientCredentialsRequired

Token URL:

Query parameters

querystringRequired

Free text search parameter.

formatstring · enumOptional

The format the response will be returned in.

Possible values:

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"]Possible values:

Responses

200

Retrieves addresses based on a free text search.

application/jsonapplication/xml

get

/find

HTTPcURLJavaScriptPython

GET /search/names/v1/find?query=text HTTP/1.1
Host: api.os.uk
key: YOUR_API_KEY
Authorization: Bearer YOUR_OAUTH2_TOKEN
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"
    }
  ]
}