Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

filter
string
default:""

Filters the response data based on the value provided.

A term filter is required; without one the search returns nothing rather than every street in the country. A term of digits only is a USRN, and is looked up rather than searched for: it returns at most one street. Any other term is passed to the gazetteer as a street name query.

An after filter, naming the USRN of the last street on the previous page, asks for the next page: and(eq(term,"high street"),eq(after,42502279)).

For more information on using named filters, see the docs

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

Get a list of results.

JSON API response object

data
A list of results · object[]
required
meta
object
required
jsonapi
object
required