Additional Data Parameter
List of KeyValuePairType elements as generic container to attach additional information to requests.
Key | Value |
---|---|
CrossingStreets | true/false , determines whether the response contains cross streets. |
PreserveUnitDesignators | |
Country2 | true/false , determines whether ISO-3166 alpha-2 country codes are returned in the response address AddressType.additionalData[Country2] element. By default, two-letter codes are not returned. |
IncludeChildPOIs | true/false , determines whether child POIs are returned with their parent POI. Examples for POIs with a parent/child relationship are airports and their terminals or national parks and their entrances. By default, child POIs are not returned. |
IncludeRoutingInformation | true/false , determines whether additional information needed for precise routing instructions is returned with the request. The data is stored in additional data fields in returned Location elements. The keys for all of these entries are prefixed with the string routing , enabling filtering on client side. |
AdditionalAddressProvider | List of Provider IDs (space separated) for address source that should be considered additionally in the search. Currently only provider ID 24 is supported. Provider 24 adds some addresses in Germany for which the map data does not have geometry yet. The addresses therefore only have a display coordinate. If data from an additional address provider is returned, the corresponding |
HouseNumberMode | Defines how to geocode unknown house numbers. The following values are supported:
|
FlexibleAdminValues | N (positive integer <= 1). Customizes flexibility in the input values for the admin hierarchy defined in
Please note this option is for geocoding addresses and needs at least street level input to work as designed. It will not return expected results when the input is a named place only (e.g. city or district name). |
IntersectionSnapTolerance | N (float in [0, 1]). When reverse geocoding a coordinate, the value controls how strictly an address match is snapped to the next intersection. A value of 0 indicates that no points on a link are snapped to an intersection; a value of 1 indicates that most probably a street intersection is returned as a match. Default value is 0. |
AddressRangeSqueezeOffset | N (positive integer), offset in meters which moves the first and last locations of an address range on a link away from the center point of an intersection. If no value for the AddressRangeSqueezeOffset or the AddressRangeSqueezeFactor parameters is provided, a default constant offset is used. |
AddressRangeSqueezeFactor | N (float in [0, 1]). Similar to AddressRangeSqueezeOffset; the value is provided relatively to the link length as a percentage. 0.5 means 20% squeeze on both sides. 1 means range squeezed to point. 0 means no squeeze but also no default constant offset. |
IncludeShapeLevel | Area level used to populate the shape information in the location results. Supported levels are: |
RestrictLevel | Area level used to restrict address results. When reverse geocoding a coordinate, only address results within the enclosing admin area of the specified level are returned. The parameter can be used to restrict results to the country of the input coordinate. Only |
SuppressStreetType | Controls if streets of a specific type should be suppressed in the result. Currently only the following type is supported:
|
NormalizeNames | Normalized means name normalization for all Geocoder API components. |
IncludeDistanceMarkers | The option is supported for the |
IncludeMicroPointAddresses | true/false , option to match and retrieve Micro Point Address information in the results. For recognized address units a micro point unit address is returned as related location. The following secondary units are supported when preceding a micro point unit address with a point address:
The option is supported for the |