Find

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

get

/find

Authorizations

api-keyapi-key-headeroauth2

Query parameters

querystringrequired

Free text search parameter.

formatstring · enum

The format the response will be returned in.

Options: JSON, XML

maxresultsinteger · min: 1 · max: 100

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

offsetinteger · min: 1

Offset the list of returned results by this amount.

boundsnumber[]

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

Example: [414000,114000,414100,114100]

fqstring · enum

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"]

Options: Airfield, Airport, Bay, Beach, Bus_Station, Channel, Chemical_Works, Cirque_Or_Hollow, City, Cliff_Or_Slope, Coach_Station, Coastal_Headland, Electricity_Distribution, Electricity_Production, Estuary, Further_Education, Gas_Distribution_or_Storage, Group_Of_Islands, Hamlet, Harbour, Helicopter_Station, Heliport, Higher_or_University_Education, Hill_Or_Mountain, Hill_Or_Mountain_Ranges, Hospice, Hospital, Inland_Water, Island, Medical_Care_Accommodation, Named_Road, Non_State_Primary_Education, Non_State_Secondary_Education, Numbered_Road, Oil_Distribution_or_Storage, Oil_Refining, Oil_Terminal, Other_Coastal_Landform, Other_Landcover, Other_Landform, Other_Settlement, Passenger_Ferry_Terminal, Port_Consisting_of_Docks_and_Nautical_Berthing, Postcode, Primary_Education, Railway, Railway_Station, Road_User_Services, Sea, Secondary_Education, Section_Of_Named_Road, Section_Of_Numbered_Road, Special_Needs_Education, Spot_Height, Suburban_Area, Tidal_Water, Town, Tramway, Urban_Greenspace, Valley, Vehicular_Ferry_Terminal, Vehicular_Rail_Terminal, Village, Waterfall, Wetland, Woodland_Or_Forest

Responses

application/jsonapplication/xml

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.os.uk/search/names/v1/find?query=text'

200

200

application/json

application/xml

application/json

{
  "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"
    }
  ]
}

Retrieves addresses based on a free text search.