v1

latestOpenAPI 3.0.02026-07-1419035.1 KB
Reverse Geocoding

Reverse Geocode

get/search/{versionNumber}/reverseGeocode/{position}.{ext}

Path parameters

versionNumber2 required

Service version number. The current value is 2.

positionstring required

This is specified as a comma separated string composed of lat., lon.

ext'json' | 'jsonp' | 'js' | 'xml' required

Expected response format.

Query parameters

spatialKeysboolean

If the "spatialKeys" flag is set, the response will also contain a proprietary geospatial keys for a specified location.

returnSpeedLimitboolean

To enable return of the posted speed limit (where available).

headingnumber float

The directional heading in degrees, usually similar to the course along a road segment. Entered in degrees, measured clockwise from north (so north is 0, east is 90, etc.)

radiusinteger

The maximum distance in meters from the specified position for the reverse geocoder to consider.

numberstring

If a number is sent in along with the request, the response may include the side of the street (Left/Right) and an offset position for that number.

returnRoadUseboolean

Enables return of the road use array for reverse geocodes at street level.

roadUsestring

Restricts reverse geocodes to a certain type of road use. The road use array for reverse geocodes can be one or more of: ["LimitedAccess", "Arterial", "Terminal", "Ramp", "Rotary", "LocalStreet"].

callbackstring

Specifies the jsonp callback method.

Response

OK: the search successfully returned zero or more results.