| Parameter |
Required |
Description |
Example |
Possible Value |
| apiKey |
true |
Click here for your API key |
api-key-value |
some text |
| version |
true |
api version |
3.01 |
3.01 |
| streetAddress |
false |
non-parsed street address value |
3620 North Vermont Ave W. |
some text |
| city |
false |
city value |
Beverly Hills |
some text |
| state |
false |
state value |
CA |
some text |
| zip |
false |
zip code value |
90089 |
some text |
| census |
false |
calculate census variables (takes longer) |
true |
true, false |
| censusYear |
false |
the year of census data to intersect with |
2010 |
1990, 2000, 2010 |
| format |
false |
output format |
csv |
csv, (results in comma separated values)
tsv, (results in tab separated values)
xml, (results in XML format)
kml, (results in a KML file)
googleMapsUrl, (results in a URL to show the output in Google Maps)
|
| includeHeader* |
false |
include column headers for text (csv/tsv) output |
true |
true (include field headers)
false (don't include field headers)
|
| notStore |
false |
indicates if the transaction details should not be historically stored in your account |
true |
true, false |
| Position |
Field |
Required |
Description |
Possible Values |
| 0 |
Transaction Id |
true |
Query Id |
Unique Id
|
| 1 |
API Version |
true |
Vesion of the API used |
3.01
|
| 2 |
Query Status Code |
true |
Result code |
See list
|
| 3 |
Latitude |
true |
Decimal |
|
| 4 |
Longitude |
true |
Decimal |
|
| 5 |
NAACCR GIS Coordinate Quality Code* |
true |
Geocode quality code in NAACCR standard |
See list
|
| 6 |
NAACCR GIS Coordinate Quality Name* |
true |
Name of the geocode quality code in NAACCR standard |
See list
|
| 7 |
Match Score |
true |
Match percentage between input data and reference feature |
|
| 8 |
Match Type |
true |
Geocode match type |
See list
|
| 9 |
Matching Geography Type |
true |
Geographic level of the output |
See list
|
| 10 |
Region Size* |
true |
Area of spatial uncertainty of the geocode |
decimal number
|
| 11 |
Region size units* |
true |
Units of area of spatial uncertainty of the geocode |
square meters (m), square kilometers (km)
|
| 12 |
Matched Location Type |
true |
Type of input data identified |
See list
|
| 13 |
Time Taken |
true |
Processing time |
Milliseconds
|
| 14 |
Census Year |
true |
Year of the census data returned |
NineteenNinety, TwoThousand, TwoThousandTen, TwoThousandTwenty, AllAvailable
|
| 15 |
NAACCR Census Tract Certainty Code* |
true |
Centainty code for the Census tract assignment in NAACCR standard |
See list
|
| 16 |
NAACCR Census Tract Certainty Name* |
true |
Name of the centainty code for the Census tract assignment in NAACCR standard |
See list
|
| 17 |
Census Block |
false |
Census block value for the output point |
|
| 18 |
Census Block |
false |
Census block value for the output point |
|
| 19 |
Census Block Group |
false |
Census block group value for the output point |
|
| 20 |
Census Tract |
false |
Census tract value for the output point |
|
| 21 |
Census County Fips |
false |
Census county fips value for the output point |
|
| 22 |
Census CBSA Fips |
false |
Census core base statistical area fips value for the output point |
|
| 23 |
Census CBSA Micro |
false |
Census core base statistical area micropolitan flag for the output point |
|
| 24 |
Census MCD Fips |
false |
Census minor civil division fips value for the output point |
|
| 25 |
Census MetDiv Fips |
false |
Census metropolitan division fips value for the output point |
|
| 26 |
Census MSA Fips |
false |
Census metropolitan statistical area fips value for the output point |
|
| 27 |
Census Place Fips |
false |
Census place fips value for the output point |
|
| 28 |
Census State Fips |
false |
Census state fips value for the output point |
|