Geocode Resource

Key-value pairs that provide additional input to requests. See Additional Data Parameter for a full list. Key and value are separated using a ,. Multiple key-value pairs are separated using a ;:

additionaldata=<Key1>,<Value1>;<Key2>,<Value2>;...

Example:

additionaldata=PreserveUnitDesignators,true;
IncludeZipAddon,true

A comma-separated list whose elements are present in the response data.

Enumeration [country, state, county, city, district, subdistrict, street, houseNumber, postalCode, addressLines, additionalData]

Abbreviated forms: [ctr, sta, cty, cit, dis, sdi, str, hnr, pst, aln, add]

Default in response: All except addressLines.

xs:string

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_id and app_code with every request. For more information, see the Identity & Access Management Developer Guide.

xs:string

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 app_id and app_code with every request. For more information, see the Identity & Access Management Developer Guide.

xs:string

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 apiKey with every request. For more information, see the Identity & Access Management Developer Guide.

see also GeoBoundingBoxType

A type of Spatial Filter. A spatial filter limits the search for any other attributes in the request. A bounding box bbox is specified by two latitude / longitude pairs; the first pair defines the top left corner of the bounding box, the second set the lower right. The bbox search is currently similar to mapview but it is not extended. Relevant global results are also returned.

bbox=<TopLeft.Latitude>,<TopLeft.Longitude>;
  <BottomRight.Latitude>,<BottomRight.Longitude>

xs:string

xs:string, exact match

xs:string, exact match, single ISO 3166-1-alpha-3 country code

• If both hard country filter and soft country focus parameter are set in the request the country filter takes precedence over the focus. This means results are limited to countries specified with country filter.
• bbox or mapview filter take precedence over the country focus if there is a conflict.

xs:string

xs:string

xs:int

The gen parameter enables or disables backward incompatible behavior in the API. Please see details and the generation history in chapter Different Generations of the Same API. The latest generation is always recommended. This is currently gen=9.

xs:string, exact match

The house number or house name.

xs:int

If set to 1, the first character of each JSON response attribute name is set to lower case. Default value is 0.

xs:string

Specifies the name of a user-defined function used to wrap the JSON response.

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.

A comma-separated list whose elements are present in the response data.

Enumeration [address, mapReference, mapView, addressDetails, streetDetails, additionalData, adminIds, linkInfo, adminInfo, timeZone, addressNamesBilingual, related.nearByAddress]

Abbreviated forms: [ar, mr, mv, dt, sd, ad, ai, li, in, tz, nb, rn]

The adminIds switch is available with forward geocoding only.

For retrieving Time Zone information the parameter adminInfo has to be added, e.g., locationattributes=adminInfo,timeZone

In reverse geocoding results, adminIds are always present unless turned off through locationattributes=none. locationattributes=-adminIds has no effect on reverse geocoding results.

The related.nearByAddress switch is available with the trackPosition mode of reverse geocoding only.

Default in reverse geocoding response: address, mapView, additionalData, mapReference, adminIds.

Default in forward geocoding response: address, mapView, additionalData.

With mapReference link PVID, side of street, and admin area PVIDs are present in the response data. With adminIds, only admin area PVIDs are present.

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.

See GeoBoundingBoxType

Specify the map coordinates of the app's viewport. The mapview is specified by two latitude / longitude pairs; the first pair defines the top left corner of the bounding box, the second set the lower right. Matches from within the set map view plus an extended area are ranked highest. Relevant global results are also returned.

mapview=<TopLeft.Latitude>,<TopLeft.Longitude>;
  <BottomRight.Latitude>,<BottomRight.Longitude>

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, maxresults=5 produces a maximum of 5 results per response page. If there are eight results in total, the first page contains five results and indicates that there is a second page with further results.

"metaInfo: {
  timestamp: 2012-05-10T15:10:06.227+0000
  nextPageInformation: 2
}"

xs:string

A key which identifies the page to be returned when the response is separated into multiple pages. Only relevant, if maxresults has been specified in a the original request and the request response indicates that there is a further page, for example:

"metaInfo: {
  timestamp: 2012-05-10T15:10:06.227+0000
  nextPageInformation: 2
}"

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, politicalview=USA or politicalview=FRA does not impact a response in any way.

xs:string, exact match

Postal code defined by the government of the country.

GeoProximityType, see also GeoProximityType

prox=lat,lon,radius

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 mapview. Matches from inside set area are ranked higher. Relevant global results are also returned.

A comma-separated list whose elements are present in the response data.

Enumeration [performedSearch, matchQuality, matchType, matchCode, parsedRequest]

Abbreviated forms: [ps, mq, mt, mc, pr]

Default in response: matchQuality, matchType

xs:string

xs:string, exact match

xs:string

xs:boolean

• True - if the value is available in the first language specified in the language parameter the attribute value is set directly in Address, Place, Location, and Category elements. Values in alternative languages are returned in the AlternativeValues element.
• False - the best available attribute value based on the language priorities given in language parameter is returned directly in Address, Place, Location, and Category elements. No alternatives are returned.

xs:string

An URL-encoded Base64 string of typically (but not guaranteed to be) 24 bytes. The token is generated based on the user's app_id and received after the registration process of the application.

Parameter token is deprecated, use app_code instead.