Streets

Autocomplete UK street names by prefix. Supports postcode-district filtering for more relevant results. Returns coordinates and administrative area data.

Try it

—

Endpoint

GET/v1/street/<query>

Base URL: https://autocomplete.namedone.com

SDK Usage

streets()

1import { createClient } from "@namedone/autocomplete"
2
3const nd = createClient("nd_...")
4const { results } = await nd.streets("high")

curl

1# Exchange your API key for a token
2curl -X POST https://token.namedone.com/v1 \
3  -H "Content-Type: application/json" \
4  -d '{"apiKey":"nd_..."}'
5
6# Query the streets endpoint
7curl "https://autocomplete.namedone.com/v1/street/high?token=<jwt>"

Response Format

JSON

{
  "results": [
    {
      "id": "street-0",
      "text": "High Street",
      "subtitle": "London, SW1A",
      "type": "street"
      "data": {
        "postcodeDistrict": <string>,
        "populatedPlace": <string>,
        "districtBorough": <string>,
        "county": <string>,
        "country": <string>,
        "lat": <number>,
        "lng": <number>
      }
    }
  ],
  "query": "high"
}

Data Fields

Field	Type	Description
postcodeDistrict	string	Postcode outward code (e.g. "SW14")
populatedPlace	string	Nearest populated place (e.g. "London")
districtBorough	string	District or borough name
county	string	County or unitary authority
country	string	England, Scotland, or Wales
lat	number	WGS84 latitude
lng	number	WGS84 longitude

API Query Parameters

Sent as query string parameters on the HTTP request to the API.

Parameter	Type	Default	Description
token	string	—	JWT obtained from the token API. Required for authentication.

SDK Options

Passed to the SDK methods (e.g. firstNames(query, opts)). These are processed client-side and never sent to the API.

Option	Type	Default	Description
limit	number	10	Maximum number of results (1–50). Applied client-side by the SDK.
simple	boolean	false	Simplify response: deduplicate by text and strip to {text, type}.
sortByProximity	array	—	Sort results by proximity to coordinates. Client-side only.
postcode	string	—	Postcode district for filtered search. Client-side only.

Examples

Query: high

{
  "results": [
    {
      "id": "street-0",
      "text": "High Street",
      "subtitle": "London, SW1A",
      "type": "street"
    },
    {
      "id": "street-1",
      "text": "High Road",
      "subtitle": "Manchester, M1",
      "type": "street"
    },
    {
      "id": "street-2",
      "text": "Highfield Road",
      "subtitle": "Birmingham, B1",
      "type": "street"
    }
  ],
  "query": "high"
}

Query: pem

{
  "results": [
    {
      "id": "street-0",
      "text": "Pembroke Gardens",
      "subtitle": "London, SW14",
      "type": "street"
    },
    {
      "id": "street-1",
      "text": "Pembroke Road",
      "subtitle": "Bristol, BS1",
      "type": "street"
    }
  ],
  "query": "pem"
}

Notes

For postcode-filtered search, use the streetsInPostcode() SDK method or the /v1/street/in/<postcode>/<query> endpoint.
Street data covers Great Britain (England, Scotland, Wales). Northern Ireland is not included due to licensing restrictions.
Coordinates are converted from OSGB36 (British National Grid) to WGS84, accurate to ~100–200m.
Contains OS data © Crown copyright and database right. Contains Royal Mail data © Royal Mail copyright. Source: Ordnance Survey, OGL v3.0.