Reverse Geocoding Batch

Batch reverse geocoding allows you to reverse geocode a set of geographic coordinates into street addresses through a POST request. The request body contains the collection of coordinates to reverse geocode. The response returns a list of addresses in JSON format.

POST /locations/reverse/batch

Resource URL

https://pcmiler.alk.com/apis/rest/v1.0/service.svc/locations/reverse/batch

Request Body

The request body consists of a JSON formatted ReverseGeocodeRequestBody object. See details in ReverseGeocode Request.

Element Definition Required
request A ReverseGeocodeRequestBody System Object. Y

Sample JSON POST Body

{
  "request": {
    "Coords": [
      {
        "Lat": 39.958188,
        "Lon": -75.163244,
        "Region": 4,
        "SpeedLimitOption": {
          "CurrentSpeed": 40,
          "Heading": 180,
          "Urban": true,
          "Vehicle": 0,
          "SpeedLimitPreference": 0
        },
        "Timestamp": "2017-01-21 12:30 PM"
      },
      {
        "Lat": 40.958188,
        "Lon": -75.163244,
        "Region": 4,
        "Timestamp": "2017-06-21 3:30 PM"
      }
    ],
    "MatchNamedRoadsOnly": false,
    "MaxCleanupMiles": 99999,
    "IncludePostedSpeedLimit": true,
    "CountryAbbrevType": 0
  }
}

Response Body

The request body consists of a JSON formatted array of GeocodeOutputLocation objects.

Sample Response

{
  "ReverseGeoBatchResult": [
    {
      "Address": {
        "StreetAddress": "Vine Street West",
        "City": "Philadelphia",
        "State": "PA",
        "Zip": "19102",
        "County": "Philadelphia",
        "Country": "United States",
        "SPLC": null,
        "CountryPostalFilter": 0,
        "AbbreviationFormat": 0,
        "CountryAbbreviation": "US"
      },
      "Coords": {
        "Lat": "39.958188",
        "Lon": "-75.163244"
      },
      "Region": 4,
      "Label": "",
      "PlaceName": "",
      "TimeZone": "EST",
      "Errors": [],
      "SpeedLimitInfo": {
        "Speed": 35,
        "SpeedType": 2,
        "SpeedTypeString": "Premium",
        "LinkIds": null,
        "RoadClass": "Secondary",
        "Units": "KPH"
      },
      "ConfidenceLevel": "Exact",
      "DistanceFromRoad": 0.001,
      "CrossStreet": null
    },
    {
      "Address": {
        "StreetAddress": "Mountain Road",
        "City": "Stroudsburg",
        "State": "PA",
        "Zip": "18360",
        "County": "Monroe",
        "Country": "United States",
        "SPLC": null,
        "CountryPostalFilter": 0,
        "AbbreviationFormat": 0,
        "CountryAbbreviation": "US"
      },
      "Coords": {
        "Lat": "40.958188",
        "Lon": "-75.163244"
      },
      "Region": 4,
      "Label": "",
      "PlaceName": "",
      "TimeZone": "EDT",
      "Errors": [],
      "SpeedLimitInfo": {
        "Speed": 25,
        "SpeedType": 0,
        "SpeedTypeString": "Default",
        "LinkIds": null,
        "Units": "KPH"
      },
      "ConfidenceLevel": "Exact",
      "DistanceFromRoad": 0.027,
      "CrossStreet": null
    }
  ]
}