TAMU GeoServices
About Services Pricing Support News
Log In Sign Up
  • Address Processing
  • Geocoding
    • Platform Details
    • Interactive Geocoding
    • Batch Processing
    • Geocoding API
    • Desktop Client
    • Esri ToolBox
    • Other Geocoders
  • Geocode Correction
  • Census Intersection
  • k-Nearest Search
  • Reverse Geocoding
  • Drag & Drop Mapping
  • Privacy & Security
  • Terms of Use
  • Get Started Now!
    v 5.0.0 API
    • Overview
    • REST
    • SOAP
    • Examples
    Previous Versions
    • v 4.05
    • v 4.04
    • v 4.03
    • v 4.02
    • v 4.01
    • v 3.01
    • v 2.96
    • v 2.95
    • v 2.94
    • v 2.93
    • v 2.92
    • v 2.91

Texas A&M Geoservices Geocoding APIs

Services › Geocoding › API

API Version - 5.0.0

The Texas A&M Geoservices Geocoder can be used from desktop and/or web applications via the Geocoding Web Service interfaces listed below. The only required information is the API key, which is available in your account profile page. You may want to read the technical details and the known bugs.

Available API Endpoints


The following two web services provide access to the Texas A&M Geoservices geocoding system in the most standard formats used by web programmers. These APIs provide metadata about the internal working of the Texas A&M Geoservices Geocoder as well as advanced options for requesting specific computational options, reference data sources, output hierarchies, etc. (i.e., all the science under the hood).

Most people probably don't need or care about the internal workings of geocoding systems, but they are provided in the advanced APIs in hopes that more people start to!

API #1 - Standard API (Rest)

https://geoservices.tamu.edu/Api/Geocode/V5/

For calling the geocoder from scripts, web-pages, and other javascript/typescript/http based methods.


API #2 - .Net API (SOAP)

https://geoservices.tamu.edu/Api/Geocode/V5/Soap/

For calling the geocoder from a .Net program.


Standard API Input Fields

(* Fields in bold are new for this API version)
Parameter Required Description Example Possible Value
apiKey true click here for your API key api-key-value some text
version true api version 5.0.0 5.0.0
format false output format json json, csv tsv xml
streetAddress false non-parsed street address value 1101 Texas Ave some text
city false city value College Station some text
state false state value TX some text
zip false zip code value 77840 some text
census false calculate census variables (takes longer) true true, false
censusYears false comma (,) separated list of the year of census data to intersect with, or "allAvailable" 2000, 2010, allAvailable 1990, 2000, 2010, 2020, allAvailable
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
verbose false output full details (parsed address, matched address, reference feature address and details) true true, false
ShouldOutputParsedAddress* false output parsed address true true, false
ShouldOutputMatchedAddress* false output matched address true true, false
ShouldOutputReferenceFeature* false output reference feature details true true, false
ShouldOutputReferenceFeatureAddress* false output reference feature address true true, false


Additional API Input Fields For Choosing Processing Options

Parameter Required Description Values Default value
allowTies false flag to indicate to return ties as valid results or handle using the tieBreakingStrategy parameter true, false false
tieBreakingStrategy false if allowTies parameter is false, this strategy is used to break ties and not return ties as valid results chooseFirstOne (return the first one)*
flipACoin (choose and return one of the ties at random)
returnAll (return all matches)
revertToHierarchy (fail on a tie and match to the next level of the geographic hierarchy - parcel, then street, then ZIP, then city, etc.)
chooseFirstOne
confidenceLevels false sets minimum confidence level accepted for Open Addresses Source Matches 1-8 (if parameter not added - min default level of 5 will be used) Confidence Levels 5
minScore false sets minimum accepted match score 00-100 (if parameter not added - min score will default to 88) 95
exhaustiveSearch false returns all matched geocodes for an input query true, false false
aliasTables false set True to utilize city alias tables in result scoring true, false false
attributeRelaxation false whether or not to use attribute relaxation true true, false
relaxableAttributes false the attributes allowed to be relaxed; only applies if shouldUseRelaxation is true comma separated list from the following options: pre, suffix, post, city, zip pre,suffix,post,city,zip
substringMAtching false whether or not to use substring matching true, false true
soundex false whether or not to use soundex true, false true
soundexableAttributes false the attributes allowed to be soundex'ed; only applies if shouldUseSoundex is true comma separated list from the following options: name, city name,city
hierarchy false which feature matching hierarchy to use uncertaintyBased, featureMatchingSelectionMethod featureMatchingSelectionMethod
referenceDataSources false which reference data sources to use all

- or one or more of the following -

all
geometry false return the full geometry of the reference feature (creates a very large response) true, false false
multithreadedGeocoder* false run reference sources in parallel true, false false
outputStatistics* false returns processing statistics and information (json/xml only) true, false false

API Output Fields (and index for csv and tsv output)

(* Fields in bold are new for this API version)
Position Field Required Description Possible Values
0 Transaction Id true Query Id Unique Id
1 API Version true Vesion of the API used 5.0.0
2 Query Status Code true Result code See list
3 Time Taken true Processing time Milliseconds
4 Latitude true Decimal
5 Longitude true Decimal
6 Match Type true Geocode match type See list
7 Matching Geography Type true Geographic level of the output See list
8 Micro Match Status* true Micro Level Analysis Match Status
9 Match Score true Match percentage between input data and reference feature
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 NAACCR GIS Coordinate Quality Code true Geocode quality code in NAACCR standard See list
13 NAACCR GIS Coordinate Quality Name true Name of the geocode quality code in NAACCR standard See list
14 Penalty Code true --- See list
15 Penalty Code Summary true --- See list
16 Interpolation Type true --- See list
17 Interpolation Sub-Type true --- See list
18 Matched Location Type true Type of input data identified See list
19 Feature Match Type true Geocode feature match type success (only one match),
ambiguous (more than one match, all returned),
brokenTie (more than one match, the tie was broken, and only one result was returnd)
20 Feature Match Count true Number of geocodes that matched 0 (no matched found),
1 (non-ambiguous match found),
some number more than 1 (ambiguous matches found)
21 Feature Match Count Notes true --- 0 (no matched found),
1 (non-ambiguous match found),
some number more than 1 (ambiguous matches found)
22 Tie Handling Strategy true --- 0 (no matched found),
1 (non-ambiguous match found),
some number more than 1 (ambiguous matches found)
23 Tie Handling Notes true --- 0 (no matched found),
1 (non-ambiguous match found),
some number more than 1 (ambiguous matches found)
24 Feature Matching Hierarchy true --- 0 (no matched found),
1 (non-ambiguous match found),
some number more than 1 (ambiguous matches found)
25 Feature Matching Hierarchy Notes true --- 0 (no matched found),
1 (non-ambiguous match found),
some number more than 1 (ambiguous matches found)
26 MNumber true Street number of the address that matched
27 MNumberFractional true Street number fractional of the address that matched
28 MPreDirectional true Street predirectional of the address that matched
29 MPreQualifier true Street prequalifier of the address that matched
30 MPreType true Street pretype of the address that matched
31 MPreArticle true Street prearticle of the address that matched
32 MName true Street name of the address that matched
33 MPostArticle true Street postarticle of the address that matched
34 MPostQualifier true Street postqualifier of the address that matched
35 MSuffix true Street suffix of the address that matched
36 MPostDirectional true Street postdirectional of the address that matched
37 MSuiteType true Suite type of the address that matched
38 MSuiteNumber true Suite number of the address that matched
39 MPostOfficeBoxType true Post office box type of the address that matched
40 MPostOfficeBoxNumber true Post office box number of the address that matched
41 MCity true City of the address that matched
42 MConsolidatedCity true Consolidated city of the address that matched
43 MMinorCivilDivision true Minor civil division of the address that matched
44 MCountySubRegion true County sub region of the address that matched
45 MCounty true County of the address that matched
46 MState true State of the address that matched
47 MZip true Zip of the address that matched
48 MZipPlus1 true Zip+1 of the address that matched
49 MZipPlus2 true Zip+2 of the address that matched
50 MZipPlus3 true Zip+3 of the address that matched
51 MZipPlus4 true Zip+4 of the address that matched
52 MZipPlus5 true Zip+5 of the address that matched
53 PNumber true Street number of the parsed address
54 PNumberFractional true Street number fractional of the parsed address
55 PPreDirectional true Street predirectional of the parsed address
56 PPreQualifier true Street prequalifier of the parsed address
57 PPreType true Street pretype of the parsed address
58 PPreArticle true Street prearticle of the parsed address
59 PName true Street name of the parsed address
60 PPostArticle true Street postarticle of the parsed address
61 PPostQualifier true Street postqualifier of the parsed address
62 PSuffix true Street suffix of the parsed address
63 PPostDirectional true Street postdirectional of the parsed address
64 PSuiteType true Suite type of the parsed address
65 PSuiteNumber true Suite number of the parsed address
66 PPostOfficeBoxType true Post office box type of the parsed address
67 PPostOfficeBoxNumber true Post office box number of the parsed address
68 PCity true City of the parsed address
69 PConsolidatedCity true Consolidated city of the parsed address
70 PMinorCivilDivision true Minor civil division of the parsed address
71 PCountySubRegion true County sub region of the parsed address
72 PCounty true County of the parsed address
73 PState true State of the parsed address
74 PZip true Zip of the parsed address
75 PZipPlus1 true Zip+1 of the parsed address
76 PZipPlus2 true Zip+2 of the parsed address
77 PZipPlus3 true Zip+3 of the parsed address
78 PZipPlus4 true Zip+4 of the parsed address
79 PZipPlus5 true Zip+5 of the parsed address
80 FNumber true Street number of the matched reference feature
81 FNumberFractional true Street number fractional of the matched reference feature
82 FPreDirectional true Street predirectional of the matched reference feature
83 FPreQualifier true Street prequalifier of the matched reference feature
84 FPreType true Street pretype of the matched reference feature
85 FPreArticle true Street prearticle of the matched reference feature
86 FName true Street name of the matched reference feature
87 FPostArticle true Street postarticle of the matched reference feature
88 FPostQualifier true Street postqualifier of the matched reference feature
89 FSuffix true Street suffix of the matched reference feature
90 FPostDirectional true Street postdirectional of the matched reference feature
91 FSuiteType true Suite type of the matched reference feature
92 FSuiteNumber true Suite number of the matched reference feature
93 FPostOfficeBoxType true Post office box type of the matched reference feature
94 FPostOfficeBoxNumber true Post office box number of the matched reference feature
95 FCity true City of the matched reference feature
96 FConsolidatedCity true Consolidated city of the matched reference feature
97 FMinorCivilDivision true Minor civil division of the matched reference feature
98 FCountySubRegion true County sub region of the matched reference feature
99 FCounty true County of the matched reference feature
100 FState true State of the matched reference feature
101 FZip true Zip of the matched reference feature
102 FZipPlus1 true Zip+1 of the matched reference feature
103 FZipPlus2 true Zip+2 of the matched reference feature
104 FZipPlus3 true Zip+3 of the matched reference feature
105 FZipPlus4 true Zip+4 of the matched reference feature
106 FZipPlus5 true Zip+5 of the matched reference feature
107 FArea true Area of the matched feature
108 FAreaType true Area metric of the matched feature
109 FGeometry true Geometry of the matched feature as OGC GML
110 FGeometrySRID false Geometry SRID of the matched feature
111 FSource true Source of the matched feature
112 FVintage true Vintage of the matched feature
113 FPrimaryIdField true Name of the primary Id field of the matched feature
114 FPrimaryIdValue true Value of the primary Id field of the matched feature
115 FSecondaryIdField true Name of the secondary Id field of the matched feature
116 FSecondaryIdValue true Value of the secondary Id field of the matched feature
117 1990 NAACCR Census Tract Certainty Code false Centainty code for the Census tract assignment in NAACCR standard See list
118 1990 NAACCR Census Tract Certainty Name false Name of the centainty code for the Census tract assignment in NAACCR standard See list
119 1990 Census Geolocation ID false 1990 GeoLocation ID for the output point
120 1990 Census Block false 1990 Census block value for the output point
121 1990 Census Block Group false 1990 Census block group value for the output point
122 1990 Census Tract false 1990 Census tract value for the output point
123 1990 Census County Fips false 1990 Census county fips value for the output point
124 1990 Census CBSA Fips false 1990 Census core base statistical area fips value for the output point
125 1990 Census CBSA Micro false 1990 Census core base statistical area micropolitan flag for the output point
126 1990 Census MCD Fips false 1990 Census minor civil division fips value for the output point
127 1990 Census MetDiv Fips false 1990 Census metropolitan division fips value for the output point
128 1990 Census MSA Fips false 1990 Census metropolitan statistical area fips value for the output point
129 1990 Census Place Fips false 1990 Census place fips value for the output point
130 1990 Census State Fips false 1990 Census state fips value for the output point
131 2000 NAACCR Census Tract Certainty Code false Centainty code for the Census tract assignment in NAACCR standard See list
132 2000 NAACCR Census Tract Certainty Name false Name of the centainty code for the Census tract assignment in NAACCR standard See list
133 2000 Census Geolocation ID false 2000 GeoLocation ID for the output point
134 2000 Census Block false 2000 Census block value for the output point
135 2000 Census Block Group false 2000 Census block group value for the output point
136 2000 Census Tract false 2000 Census tract value for the output point
137 2000 Census County Fips false 2000 Census county fips value for the output point
138 2000 Census CBSA Fips false 2000 Census core base statistical area fips value for the output point
139 2000 Census CBSA Micro false 2000 Census core base statistical area micropolitan flag for the output point
140 2000 Census MCD Fips false 2000 Census minor civil division fips value for the output point
141 2000 Census MetDiv Fips false 2000 Census metropolitan division fips value for the output point
142 2000 Census MSA Fips false 2000 Census metropolitan statistical area fips value for the output point
143 2000 Census Place Fips false 2000 Census place fips value for the output point
144 2000 Census State Fips false 2000 Census state fips value for the output point
145 2010 NAACCR Census Tract Certainty Code false Centainty code for the Census tract assignment in NAACCR standard See list
146 2010 NAACCR Census Tract Certainty Name false Name of the centainty code for the Census tract assignment in NAACCR standard See list
147 2010 Census Geolocation ID false 2010 GeoLocation ID for the output point
148 2010 Census Block false 2010 Census block value for the output point
149 2010 Census Block Group false 2010 Census block group value for the output point
150 2010 Census Tract false 2010 Census tract value for the output point
151 2010 Census County Fips false 2010 Census county fips value for the output point
152 2010 Census CBSA Fips false 2010 Census core base statistical area fips value for the output point
153 2010 Census CBSA Micro false 2010 Census core base statistical area micropolitan flag for the output point
154 2010 Census MCD Fips false 2010 Census minor civil division fips value for the output point
155 2010 Census MetDiv Fips false 2010 Census metropolitan division fips value for the output point
156 2010 Census MSA Fips false 2010 Census metropolitan statistical area fips value for the output point
157 2010 Census Place Fips false 2010 Census place fips value for the output point
158 2010 Census State Fips false 2010 Census state fips value for the output point
159 2020 NAACCR Census Tract Certainty Code false Centainty code for the Census tract assignment in NAACCR standard See list
160 2020 NAACCR Census Tract Certainty Name false Name of the centainty code for the Census tract assignment in NAACCR standard See list
161 2020 Census Geolocation ID false 2020 GeoLocation ID for the output point
162 2020 Census Block false 2020 Census block value for the output point
163 2020 Census Block Group false 2020 Census block group value for the output point
164 2020 Census Tract false 2020 Census tract value for the output point
165 2020 Census County Fips false 2020 Census county fips value for the output point
166 2020 Census CBSA Fips false 2020 Census core base statistical area fips value for the output point
167 2020 Census CBSA Micro false 2020 Census core base statistical area micropolitan flag for the output point
168 2020 Census MCD Fips false 2020 Census minor civil division fips value for the output point
169 2020 Census MetDiv Fips false 2020 Census metropolitan division fips value for the output point
170 2020 Census MSA Fips false 2020 Census metropolitan statistical area fips value for the output point
171 2020 Census Place Fips false 2020 Census place fips value for the output point
172 2020 Census State Fips false 2020 Census state fips value for the output point


API Examples - By Reference Data Source - In priority order

All examples below use:

  • format=json
  • census=true
  • censusYear=allAvailable
  • shouldOutputParsedAddress=true
  • shouldOutputReferenceFeature=true
  • shouldOutputReferenceFeatureAddress=true


Building/Parcel-level files


Source Vintage Example Query Notes
PreComputed Points updated continuously 324 E 12TH ST, FAYETTEVILLE, AR, 72701
Microsoft Footprints updated continuously 1207 Winding Road, College Station, TX, 77840
County Parcel Data updated continuously 301 Tarrow St, College Station, TX, 77840
Open Addresses updated continuously 1211 Winding Road, College Station, TX, 77840
Navteq Points 2017 1101 Texas Ave, College Station, TX, 77840 bring your own license
Navteq Points 2016 1211 Winding Road, College Station, TX, 77840 bring your own license
Navteq Points 2014 1211 Winding Road, College Station, TX, 77840 bring your own license
Navteq Points 2013 1211 Winding Road, College Station, TX, 77840 bring your own license
Navteq Points 2012 1211 Winding Road, College Station, TX, 77840 bring your own license
Boundary Solutions 2012 1101 Texas Ave, College Station, TX, 77840


Street-level files


Source Vintage Example Query Notes
Navteq Streets 2022 3050 W Paisano Dr, El Paso, TX, 79905 bring your own license
Navteq Streets 2021 1211 Winding Road, College Station, TX, 77840 bring your own license
Census TigerLines 2022 1211 Winding Road, College Station, TX, 77840
Census TigerLines 2016 1211 Winding Road, College Station, TX, 77840
Census TigerLines 2015 1211 Winding Road, College Station, TX, 77840
Navteq Streets 2012 1211 Winding Road, College Station, TX, 77840 bring your own license
Census TigerLines 2010 1211 Winding Road, College Station, TX, 77840
Navteq Streets 2008 1211 Winding Road, College Station, TX, 77840 bring your own license


Zip-level files


Source Vintage Example Query Notes
USPS Tiger Zip+4 updated continuously 1211 Winding Road, College Station, TX, 77840-1200
Commercial Zips updated continuously 1211 Winding Road, College Station, TX, 77840
Census ZCTAs 2020 1211 Winding Road, College Station, TX, 77840
Census ZCTAs 2010 1211 Winding Road, College Station, TX, 77840
Census ZCTAs 2000 1211 Winding Road, College Station, TX, 77840


City-level files


Source Vintage Example Query Notes
Census Places 2020 1211 Winding Road, College Station, TX, 77840 Uses minScore=50 to allow city-level matches
Census Places 2010 1211 Winding Road, College Station, TX, 77840 Uses minScore=50 to allow city-level matches
Census Places 2000 1211 Winding Road, College Station, TX, 77840 Uses minScore=50 to allow city-level matches
Census Consolidated Cities 2020 2450 S Milledge Ave, Athens, GA, 30605 Uses minScore=50 to allow city-level matches
Census Consolidated Cities 2010 2450 S Milledge Ave, Athens, GA, 30605 Uses minScore=50 to allow city-level matches
Census County Sub-Regions 2020 102 Cypress St, Abilene, TX, 79601 Uses minScore=40 to allow county-sub-level matches
Census County Sub-Regions 2010 102 Cypress St, Abilene, TX, 79601 Uses minScore=40 to allow county-sub-level matches
Census County Sub-Regions 2000 102 Cypress St, Abilene, TX, 79601 Uses minScore=40 to allow county-sub-level matches


County-level files


Source Vintage Example Query Notes
Census Counties 2020 1211 Winding Road, Brazos County, TX, 77840 Uses minScore=40 to allow county-level matches
Census Counties 2010 1211 Winding Road, Brazos County, TX, 77840 Uses minScore=40 to allow county-level matches
Census Counties 2000 1211 Winding Road, Brazos County, TX, 77840 Uses minScore=40 to allow county-level matches


State-level files


Source Vintage Example Query Notes
Census States 2020 1211 Winding Road, College Station, TX, 77840 Uses minScore=5 to allow state-level matches
Census States 2010 1211 Winding Road, College Station, TX, 77840 Uses minScore=5 to allow state-level matches

API Examples - By Census Year

All examples below use:

  • format=json
  • census=true
  • refs=MicrosoftFootprints
  • shouldOutputParsedAddress=true
  • shouldOutputReferenceFeature=true
  • shouldOutputReferenceFeatureAddress=true

CensusYear Example Query Notes
censusYear=allAvailable (1990, 2000, 2010, 2020) 1207 Winding Road, College Station, TX, 77840
censusYear=1990 1207 Winding Road, College Station, TX, 77840
censusYear=2000 1207 Winding Road, College Station, TX, 77840
censusYear=2010 1207 Winding Road, College Station, TX, 77840
censusYear=2020 1207 Winding Road, College Station, TX, 77840 Note: Census 2020 data values will not be populated until the Census 2020 data are released.
Note: The Census 2020 release date is currently unknown, at least to us anyway.
censusYear=2000,2010 1207 Winding Road, College Station, TX, 77840
censusYear=1990,2000,2010 1207 Winding Road, College Station, TX, 77840
censusYear=1990,2000,2010,2020 1207 Winding Road, College Station, TX, 77840

API Examples - By Output Type

Example 1 - 1101 Texas Ave, College Station, TX, 77840 (json,no census)

Example 2 - 1101 Texas Ave, College Station, TX, 77840 (json, verbose, no census)

Example 3 - 1101 Texas Ave, College Station, TX, 77840 (json, with 2000 & 2010 census)

Example 4 - 1101 Texas Ave, College Station, TX, 77840 (json, with 1990, 2000 & 2010 census, exhaustive searching)

Example 5 - 1101 Texas Ave, College Station, TX, 77840 (json, with 2000 & 2010 census)

Example 6 - 1101 Texas Ave, College Station, TX, 77840 (CSV, with field headers)

Example 7 - 1101 Texas Ave, College Station, TX, 77840 (CSV, verbose, with field headers)

Example 8 - 1101 Texas Ave, College Station, TX, 77840 (CSV, with all available census and field headers)

Example 9 - 1101 Texas Ave, College Station, TX, 77840 (CSV, verbose, with all available census and field headers)

Example 10 - 1101 Texas Ave, College Station, TX, 77840 (CSV, with all available census and field headers)

Example 11 - 1101 Texas Ave, College Station, TX, 77840 (XML, without census)

Example 12 - 1101 Texas Ave, College Station, TX, 77840 (XML, with 2000 & 2010 census)

Example 13 - 123 Main Street, Los Angeles, ca, 90007 (XML, for an address that has a tie, without ties allowed and flipACoin as tie handling strategy - will match at street level and pick one of two options)

Example 14 - 123 Main Street, Los Angeles, ca, 90007 (XML, for an address that has a tie, without ties allowed and revertToHierarchy as tie handling strategy - will fail at street level because it was ambigous and match at zip code because it is the next level of geography in the hierarchy)

Example 15 - 123 Main Street, Los Angeles, ca, 90007 (XML, for an address that has a tie, with ties allowed - will return ambigous street level matches)

Example 16 - 123 Main Street, Los Angeles, ca, 90007 (same as example #7 but TSV with header fields)

Example 17 - 123 Main Street, Los Angeles, ca, 90007 (same as example #8 but TSV with ties not allowed and flipACoin as tie breaking strategy)

Example 18 - 123 Main Street, Los Angeles, ca, 90007 (same as example #9 with all census years turned on)

Example 19 - 668 Woodrow Rd, Staten Island, NY, 10312 (XML, confidence levels 1-3 returns match with confidence level 3)

Example 20 - 668 Woodrow Rd, Staten Island, NY, 10312 (XML, confidence level 1 fails to return Open Addresses match due to confidence setting but returns match from Navteq Points)

Example 21 - 668 Woodrow Rd, Staten Island, NY, 10312 (XML, with exhaustive search)

Example 22 - 668 Woodrow Rd, Staten Island, NY, 10312 (XML, with ShouldOutputStatistics=true)



Texas A&M University © 2022 · GeoInnovation Service Center · B-GSVCSWEB | Version-20240612.5 | Release-122
About Contact Careers Security Policy Privacy Policy