Search locations (statistical areas)

GET/api/v1.1/{country_code}/search/locations

Allows searching our location taxonomy for locations / statistical areas matching a given search term q.

Example uses for this data include creating a searching for a specific location for use in further requests, or populating a typeahead / autocomplete in a user interface.

Request

Authorization: API Key

Add parameter in header

Authorization

Example

Authorization: 2f68dbbf-519d-4f01-9636-e2421b68f379

Path Params

country_code

string

required

A two character code that specifies which country dataset to query.

Example:

Match pattern:

[a-z]{2}

Query Params

exclude_type_id

integer

optional

Exclude locations / statistical areas of with a given type ID from the results.

limit

integer

optional

The maximum number of matches to return in a search.

>= 1

Default:

string

required

The search query.

>= 3 characters

type_id

integer

optional

Limit the search to locations / statistical areas of the specified type.

Request samples

Responses

Request successful.(200)

Request successful.

HTTP Code: 200

Content Type : JSONapplication/json

array of:

integer

read-onlyrequired

The unique ID of the location / statistical area.

name

string

required

The name of the location / statistical area.

<= 128 characters

code

string

required

The official government code for the location / statistical area.

<= 16 characters

type_id

integer

read-onlyrequired

The unique ID of the location / statistical area type for this location / statistical area.

country_id

integer

read-onlyrequired

The unique ID of the country to which this location / statistical area belongs.

>= -2147483648<= 2147483647

[
  {
    "id": 20,
    "name": "North East (England)",
    "code": "TLC",
    "type_id": 20,
    "country_id": 1
  }
]

Last modified: 5 months ago