List of available countries
List of available countries
| ISO Code | Country Name |
|---|---|
| CZ | Czech Republic |
| DE | Germany |
| ES | Spain |
| FR | France |
| GB | United Kingdom |
| HU | Hungary |
| IE | Ireland |
| IT | Italy |
| JP | Japan |
| KR | Republic of Korea |
| NL | The Netherlands |
| PL | Poland |
| PT | Portugal |
| RO | Romania |
| SL | Slovenia |
| SK | Slovakia |
| US | United States |
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
The key used to authenticate with the service. For example: 'AA11-AA11-AA11-AA11'
The search text to find. This can be a Town, City, State, Postcode or ZIP Code. Requests made using this as an input will be free.
A comma separated list of ISO2 or ISO3 country codes (e.g. GB or GBR). This will limit the search to those countries.
The maximum number of results that will be returned. If not set this will default to 7. The maximum possible value is 100.
The types that you want to be returned in the response. Valid types are Locality | Postcode | AdministrativeArea. This can be set to include multiple types (comma separated). For example, passing "Postcode" will only return Postcode results; passing "Locality, Postcode" will return both Locality and Postcode.
A starting location for the search. This can be the name or ISO 2 or 3 character code of a country, WGS84 coordinates (comma separated) or IP address to search from.
The unique identifier for a location, as provided in a previous Input search. For example: "VE_CiVlgwok_QT1BPT4_QT1FP0U-PT5Dwok_QD0". Requests made with this parameter will return co-ordinates and be charged.
Response
Success
The unique identifier for a returned location. For example: "VE_CiVlgwok_QT1BPT4_QT1FP0U-PT5Dwok_QD0". This can be used in a subsequent "addressID" search to return co-ordinates for the location.
The first half of the result that's displayed to the user. For example, if the returned location is "Worcester, Worcestershire" then Text will display "Worcester".
The type of location returned. Possible values include: SuperAdministrativeArea |AdministrativeArea | SubAdministrativeArea | Locality | DependentLocality | DoubleDependentLocality | Postcode
The second half of the location that's displayed to the user, featuring the broader geographic area. For example, if the returned location is "Worcester, Worcestershire" then Description will display "Worcestershire" as this is the larger geographic area.
A list of number ranges showing which characters in the Text and Description fields match the user's search term. This can be used to determine which characters should be highlighted in bold in the search field, to give the user a visual representation of what's being searched. See here for more details.
The ISO code of the display language for a result (for example: "ENG" to represent English).
An array containing the Latitude and Longitude co-ordinates for the given location.
Currently will always return blank.
A smaller population centre, dependent on the contents of the Locality field (i.e. District). Can only be present if Locality is present.
Currently will always return blank.
The largest administrative district within a country, if applicable (most countries only use AdministrativeArea).
A locality within a Dependent locality.
The name of the street or thoroughfare. Will only display for UK postcodes.
The most common administrative district within a country (i.e. US State or UK County).
Currently will always return blank.
In the US this can be used to define a county within a state or a sub area of a city.
The most common population centre within a country (i.e. USA City, Canadian Municipality).
The full postal code of the address (i.e. Postcode, ZIP Code, etc.).
Currently will always return blank.
Currently will always return blank.
Currently will always return blank.
Currently will always return blank.
The full name of the country the location is in, as per the ISO 3166-1 standard. Intended for display purposes if you want to present this to the customer.