GET
/
StoreFinder
/
Interactive
/
FindPlaceNames
/
v1.10
/
json6.ws
cURL
curl --request GET \
  --url https://api.addressy.com/StoreFinder/Interactive/FindPlaceNames/v1.10/json6.ws
{
  "Items": [
    {
      "Id": "GBR|PC|1717050",
      "Place": "WR26NJ"
    }
  ]
}
This method does not consume credit.

Query Parameters

​
Key
string
required

The key to use to authenticate to the service.

​
SearchTerm
string
required

The name of the place to find. It can be a town or city, point of interest or postal code.

​
MatchType
string

Determines whether fuzzy searching is used to find records. This is ignored if a postal code is part of the SearchTerm. "Exact" requires the name to match the record exactly; "Partial" requires the search term to exactly match part of the name; "Similar" will return records with similar names if a "Partial" match was not initially possible.

​
Country
string

The name or ISO 2 or 3 character code for the country to search in. Most country names will be recognised but the use of the ISO country code is recommended for clarity.

Response

200
application/json

Success

The response is of type object.