POST
/
LocationServices
/
Geocoding
/
GlobalTypeAhead
/
v1.10
/
json6.ws
cURL
curl --request POST \
  --url https://api.addressy.com/LocationServices/Geocoding/GlobalTypeAhead/v1.10/json6.ws \
  --header 'Content-Type: application/json' \
  --data '{
  "Key": "<string>",
  "Input": "<string>",
  "Countries": "<string>",
  "Limit": 7,
  "Types": "<string>",
  "Origin": "<string>",
  "addressID": "<string>"
}'
[
  {
    "Id": "<string>",
    "Text": "<string>",
    "Type": "<string>",
    "Description": "<string>",
    "Highlight": "<string>",
    "Language": "<string>",
    "Location": {
      "Latitude": 123,
      "Longitude": 123
    },
    "DependentThoroughfare": "<string>",
    "DependentLocality": "<string>",
    "OrganisationName": "<string>",
    "SuperAdministrativeArea": "<string>",
    "DoubleDependentLocality": "<string>",
    "Thoroughfare": "<string>",
    "AdministrativeArea": "<string>",
    "BuildingName": "<string>",
    "SubAdministrativeArea": "<string>",
    "Locality": "<string>",
    "Postcode": "<string>",
    "Department": "<string>",
    "SubBuilding": "<string>",
    "SubBuildingFloor": "<string>",
    "Number": "<string>",
    "Country": "<string>",
    "Iso2": "<string>",
    "Iso3": "<string>",
    "AdditionalFields": {
      "Easting": 123,
      "Northing": 123
    }
  }
]
The Global Geocoding API currently supports an initial set of 17 countries, with more scheduled for inclusion in the near future. See the ‘List of available countries’ section below for details of which territories are available.
Text searches using the “Input” field are always free. This method will consume credit per “addressID” search and co-ordinates returned.

​
Use of geocodes/addresses

Use of the output of the Global Geocoding API is temporary, and only for use as part of a Store Finder. It is not permitted to index or store results for other purposes, such as use in a checkout process. For further information please see the Loqate Terms and Conditions.

Body

application/json

Response

200
application/json

Success

The response is of type ListOfExternalTypeaheadResponseItem · object[].