Reverse Geocode Resource
- Last UpdatedDec 13, 2024
- 6 minute read
Reverse Geocode Resource
.../6.2/reversegeocode.{format}?<parameter>=<value>...
Parameter | Element |
---|---|
additionaldata |
Key-value pairs that provide additional input to requests. See
resource-params-additional.html
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
|
You cannot have more than two API Keys for one app at the same time. You must include an |
gen |
xs:int The |
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. |
level | xs:string Target match level of the search result. One of [country ,
state , county ,
city , district ,
postalCode ]. Only valid in combination
with gen=2 or higher. |
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.
|
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,
|
minresults |
xs:int Indicates that the service is to ignore the specified radius
until |
mode |
One of five values:
|
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,
|
pos |
A position with latitude, longitude, and bearing. Bearing expresses the direction in which an asset is heading in degrees starting at true north and continuing clockwise around the compass. North is 0 degrees, east is 90 degrees, south is 180 degrees, west is 270 degrees. |
prox |
GeoProximityType, see also resource-type-proximity.html
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. |
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.
|
sortby |
xs:string Sort results by distance (default), population count, or size
(approximate area size). One of [ Currently only supported for Reverse Geocode
|
strictlanguagemode |
xs:boolean
|
token |
xs:string An URL-encoded Base64 string of typically (but not guaranteed to
be) 24 bytes. The Parameter |