The /api/v2/geo/Geocode
Jurisdiction Determination endpoint returns a list of geocoded results.
The Geocode Jurisdiction Determination endpoint supports geocoding for US, Puerto Rico, and other US territories. Addresses and coordinate pairs in foreign countries, including Canada and Mexico, are not supported and do not return results.
Use Geo Batch for high-volume geocoding requests.
The Geocode Jurisdiction Determination endpoint accepts a list of Geocode Requests. Specify a list of street addresses or latitude/longitude coordinate pairs to geocode. Geocoded results are returned in the Geocode Result.
Either a street address or latitude/longitude pair can be specified in each individual request, but a list of geocode requests can contain a mixture of both street address and latitude/longitude pairs.
The Reference ID (ref
) is used to tie the requested address or lat/long to the result. The Reference ID is useful when a large list of geocoded results are requested.
Use the CASS flag (cass
) to indicate if the CASS validated address should be returned on a street address geocode request. cass
has no effect on a latitude/longitude geocode request and is ignored if set.
true
: Returns the CASS validated address as part of the Geocode Resultfalse
: The CASS validated address is not included in the resultsSpecify a street address using one or more of these fields:
addr
)city
)st
)zip
)city
) and State (st
)zip
)Specify a latitude/longitude coordinate pair using Latitude (lat
) and Longitude (long
).
Considerations when using latitude/longitude:
lat
) and Longitude (long
) are requiredThe Geocode Result contains the following fields:
Key | Name | Description |
---|---|---|
ref | Reference ID | Reference ID from the geocode request used to tie the request to the result |
cass | CASS Address Information | CASS validated address information including:
|
cBlk | Census Block Group | ID of the smallest area surrounded by streets, geocoded based on census data Census Block Group is always 0 for latitude/longitude requests |
cTrc | Census Tract | ID of the contiguous group of census block groups, geocoded based on census data Census Tract is always 0 for latitude/longitude requests |
cnty | County | County name of geocoded jurisdiction |
feat | Feature ID | The Geographic Names Information System (GNIS) feature id is a unique, permanent geographic feature identifier assigned by the U.S. Board on Geographic Names |
fips | FIPS Code | 10-digit number in the format of SSCCCPPPPP where SS = State Code, CCC = County Code and PPPPP = Place Code. FIPS codes that start with a “99” in the state position are Avalara-defined codes for special tax jurisdictions |
inc | Incorporated | Indicates if the address is within city limits
|
jur | Taxing jurisdiction name | Name of the taxing jurisdiction related to the returned PCode |
lat | Latitude | Latitude of the matching jurisdiction |
long | Longitude | Longitude of the matching jurisdiction |
pcd | PCode | PCode for the taxing jurisdiction |
scr | Score | A percentage, represented as a decimal, indicating the accuracy of the address match in the mapping database |
The Fallback process is used when a match can’t be found in the geocoding database and, instead, a match is found based on the Postal Code (zip
) and city name (city
).
Characteristics of a Fallback response:
scr
) is 1.01
cBlk
) and Census Tract (cTrc
) are both 0
lat
) and Longitude (long
) are both -1
This example demonstrates a geocoding request for a street address. The CASS validated address is being requested (cass
is true
).
The street address is successfully geocoded with a score (scr
) of 1.
This example geocodes a latitude/longitude coordinate pair.
The latitude/longitude coordinate pair is successfully geocoded with a score (scr
) of 0.9999.
This example shows how to send multiple geocode requests. One request is a street address while the other is a latitude/longitude coordinate pair.
Two geocoded results are returned. Use the Reference ID (ref
) to match the result to the request.
This example demonstrates the Fallback process. A valid city (city
), state (st
), and Postal Code (zip
) are used, but the street address (addr
) is invalid.
A Fallback result is returned, indicated by the score (scr
) being 1.01.
This request contains a geocode request for an unincorporated address.
The returned geocoded address is unincorporated (inc
is false
)