Geocoding APIs

Our Geocoding APIs separately support forward, reverse, and batch geocoding. For new implementations, we recommend using our Single Search API which can do all of these things. While both services offer similar results, Search has more features and can accept many types of input in a single API.

• Geocoding with the /locations resource allows you to find GPS coordinates as well as complete address information for a given street address.

• Reverse geocoding with the /locations/reverse resource instead takes in a single pair of coordinates and returns the approximate address on which that point is located. With additional licensing, a road’s speed limit information can also be provided when reverse geocoding a location.

Batch Geocoding #

If you are looking to geocode or reverse geocode a batch of addresses or GPS coordinates all at once, you can use our /locations/address/batch and /locations/reverse/batch resources.

Interactive Examples #

The following pages include interactive examples where you can test our Location APIs after entering your API key in the YOUR API KEY HERE box.

• Geocoding
• Reverse geocoding
• Batch geocoding
• Batch reverse geocoding

Below you will find descriptions of the parameters shared among these APIs, as well as sample requests and responses .

Location Request Parameters #

string

string

string

string

string

string

string

Enum

string

string

Double Array

string

string

boolean

double

boolean

object

integer

double

boolean

boolean

string

Boolean

Enum

Enum

Enum

Enum

Enum

Sample Geocode Request #

https://pcmiler.alk.com/apis/rest/v1.0/Service.svc/locations?street=1600%20Pennsylvania%20Avenue%20Northwest&city=Washington&state=DC&postcode=20500&country=US

Sample Geocode Response #

  {
      "Address": {
          "StreetAddress": "1600 Pennsylvania Avenue Northwest",
          "City": "Washington",
          "State": "DC",
          "Zip": "20500",
          "County": "District of Columbia",
          "Country": "United States",
          "SPLC": null,
          "CountryPostalFilter": 0,
          "AbbreviationFormat": 0,
          "StateName": "District of Columbia",
          "StateAbbreviation": "DC",
          "CountryAbbreviation": "US"
      },
      "Coords": {
          "Lat": "38.898730",
          "Lon": "-77.036679"
      },
      "Region": 4,
      "Label": "",
      "PlaceName": "",
      "TimeZone": "EDT",
      "Errors": [],
      "SpeedLimitInfo": null,
      "ConfidenceLevel": "Exact",
      "DistanceFromRoad": null,
      "CrossStreet": null
  }

Sample Reverse Geocode Request #

https://pcmiler.alk.com/apis/rest/v1.0/Service.svc/locations/reverse?coords=-71.227186,46.813427&matchNamedRoadsOnly=true&maxCleanupMiles=5.5

Sample Reverse Geocode Response #

{
    "Address": {
        "StreetAddress": "270 Rue Saint Joseph Est",
        "City": "Quebec",
        "State": "QC",
        "Zip": "G1K 3A9",
        "County": "",
        "Country": "Canada",
        "SPLC": null,
        "CountryPostalFilter": 0,
        "AbbreviationFormat": 0,
        "StateName": "Quebec",
        "StateAbbreviation": "QC",
        "CountryAbbreviation": "CA"
    },
    "Coords": {
        "Lat": "46.813427",
        "Lon": "-71.227186"
    },
    "Region": 4,
    "Label": "",
    "PlaceName": "",
    "TimeZone": "EDT",
    "Errors": [],
    "SpeedLimitInfo": null,
    "ConfidenceLevel": "Exact",
    "DistanceFromRoad": 0.003,
    "CrossStreet": null
}