Geocode Resource
.../6.2/geocode.{format}?<parameter>=<value>...
Parameter | Description |
---|---|
additionaldata | Key-value pairs that provide additional input to requests. See Additional Data Parameter for a full list. Key and value are separated using a Example: |
addressattributes | A comma-separated list whose elements are present in the response data. Enumeration [ Abbreviated forms: [ Default in response: All except Note: The value names are case-sensitive. |
app_id | A 20-byte Base64 URL-safe encoded string used in one of the available authentication options for the Geocoder API. If you use the app ID/app code option, you need to include an |
app_code | A 20-byte Base64 URL-safe encoded string used for the authentication of the client application. If you use the app ID/app code option, you need to include an |
apiKey | A 43-byte Base64 URL-safe encoded string used for the authentication of the client application. As a logged in user, you can generate it at https://developer.here.com/projects. API Keys never expire but you can invalidate your API Keys at any time. You cannot have more than two API Keys for one app at the same time. You must include an |
bbox | see also GeoBoundingBoxType A type of Spatial Filter. A spatial filter limits the search for any other attributes in the request. A bounding box Example: bbox=41.9085286,-87.6762943;41.8682739,-87.6041965 |
city | xs:string A country specific mapping is required. Example,
|
country | xs:string, exact match Specify the country or list of countries using the country code (3 bytes, ISO 3166-1-alpha-3) or the country name. This is a strict filter. Results are restricted to the specified country or countries. Note: To avoid ambiguity we recommend to specify the country with the 3-letter ISO code and not with the spelled out country name. With names there is a higher risk of misspells and also not all language translations for all countries are supported. |
countryfocus | xs:string, exact match, single ISO 3166-1-alpha-3 country code Results from the specified country are preferred. This is a soft filter. Spelled out country names are not supported for country focus.
|
county | xs:string Second subdivision level below the country. Depending on the admin hierarchy in a country this level might not be applicable. Example,
|
district | xs:string Subdivision level below the city. Depending on the admin hierarchy in a country this level might not be applicable. Example,
|
gen | xs:int The |
housenumber | xs:string, exact match The house number or house name. |
jsonattributes | xs:int If set to 1, the first character of each JSON response attribute name is set to lower case. Default value is 0. |
jsoncallback | xs:string Specifies the name of a user-defined function used to wrap the JSON response. |
language | LanguageCodeType The preferred language of address elements in the result. Without a preferred language, the Geocoder will return results in an official country language or in a regional primary language so that local people will understand. Language code must be provided according to RFC 4647 standard. Note that the plural form of the parameter (languages) is supported as well. But only the last specified language in the list is used. All preceding language preferences are ignored at this time. |
locationattributes | A comma-separated list whose elements are present in the response data. Enumeration [ Abbreviated forms: [ The For retrieving Time Zone information the parameter In reverse geocoding results, The Default in reverse geocoding response: Default in forward geocoding response: With Note: The value names are case-sensitive. |
locationid | xs:string, exact match A key uniquely identifying a physical location. Each record in a geocode response contains a location Id. Use the Id to retrieve the exact same location information. For example, the location Id for "1 Market Street, 94105 San Francisco" is NT_NVpegjQLOBQa8ORYk3jV7A_xA. |
mapview | Specify the map coordinates of the app's viewport. The Example: mapview=41.9085286,-87.6762943;41.8682739,-87.6041965 |
maxresults | xs:int Defines the maximum number of items in the response structure, limiting the number of results included in each response page. When more results than the defined maximum are available, then these are returned on additional, separate pages. Each response structure (page) contains a handle to the next page. For example, |
pageinformation | xs:string A key which identifies the page to be returned when the response is separated into multiple pages. Only relevant, if |
politicalview | xs:string (3 bytes, ISO 3166-1-alpha-3) Specify the political view. Available territories will be seen through the point of view of this country. If this parameter is not specified the neutral international view is made available, where territories may have unresolved claims. For a complete list of supported views please see the appendix Political View. For any political view that is unsupported the Geocoder, falls back to the default view. For example, |
postalcode | xs:string, exact match Postal code defined by the government of the country. |
prox | GeoProximityType, see also GeoProximityType A type of SpatialFilter. A spatial filter limits the search for any other attributes on the request. Proximity specifies a circle to search using a latitude, a longitude, and a radius in meters. Search is similar to |
responseattributes | A comma-separated list whose elements are present in the response data. Enumeration [ Abbreviated forms: [ Default in response: Note: he value names are case-sensitive. |
searchtext | xs:string searchtext contains free-form text containing address elements. You can specify the searchtext parameter by itself, or you can specify it with other parameters to narrow your search. For example, you can specify the state or country parameters along with a free-form address in the search text field. Note: The search text should not include non-address related elements in order to improve the relevance of results. Non-address elements in search texts can affect the quality of the results. |
state | xs:string, exact match First subdivision level below the country. Specify state using full or abbreviated notation. A country specific mapping is required, for example
|
street | xs:string The street name can include suite, apt and floor information. When searching for a street intersection two formats are supported:
|
strictlanguagemode | xs:boolean
|
token | xs:string An URL-encoded Base64 string of typically (but not guaranteed to be) 24 bytes. The Parameter |