Chapter 5.3.4 - Geocode Requests

Use Geo REST when:

  • You need quick, on-demand responses for individual addresses or latitude/longitude combinations

Geo Batch allows you to upload a CSV containing your address or latitude/longitude geocoding requests. The results can then be downloaded and exported to your database. When to use Geo Batch:

  • You have a high volume of address or latitude/longitude geocoding requests
  • You perform bill runs on a regular basis
  • You are interested in importing your response file into a spreadsheet or a database
  • A backup of the input and output data is needing to be stored in the AvaTax for Communications platform
  • An immediate response for your batch files isn't needed

Geocode Requests

The geocodeRequests object contains a list of street addresses and/or latitude/longitude coordinate pairs to geocode within the GeocodeRequest object.

Geocode Request

The geocodeRequest object contains the input data to geocode:

Note

Only address information or latitude/longitude coordinates can be provided in the request, but not both.

Key Value
ref [string] Reference ID
Optional Reference ID for the geocode request
cass [bool] CASS Validated Address
Indicates if the CASS validated address is desired in the results
  • true: Return the CASS validated address in the results
  • false: Do not return the CASS validated address
lat [double] Latitude
Latitude for geocoding based on lat/long coordinates
long [double] Longitude
Longitude for geocoding based on lat/long coordinates
addr [string] Street address
city [string] City name
st [string] State name or abbreviation
zip [string] Postal Code

Example

[
  {
    "ref": "Address Request",
    "cass": true,
    "addr": "255 S. King St.",
    "city": "Seattle",
    "st": "WA",
    "zip": "98104"
  },
  {
    "ref": "Lat/Long Request",
    "lat": 35.991130741436415,
    "long": -78.90267307450108
  }
]
PreviousNext