Optional filters, if used, further reduce the list of sites returned.
Dates
You can use this option to select sites that were/are serving the desired data types during the date range that you set.
|
URL argument name is startDT. Use the ISO-8601 date format . Examples: &startDT=1990-01-01. Specify a date only. Hours and timezone arguments are not allowed. If startDt is specified but endDt is not, endDt is assumed to be today's date.
URL argument name is endDT. Use the ISO-8601 date format . Examples: &endDT=1999-12-31. Specify a date only. Hours and timezone arguments are not allowed. If endDt is specified and startDt is not, all sites at or before the endDt are returned.
|
URL argument name is siteStatus. The site status indicates whether the site is active or inactive. A site is considered active if:
- it has collected time-series (automated) data within the last 183 days (6 months)
- it has collected discrete (manually collected) data within 397 days (13 months)
If it does not meet these criteria, it is considered inactive. Some exceptions apply. If a site is flagged by a USGS water science center as discontinued, it will show as inactive. A USGS science center can also flag a new site as active even if it has not collected any data.
Example: &siteStatus=active
|
URL argument name is siteType. You can filter for sites with certain site types. If the siteType argument does not appear in the URL, then by default all site types will be shown. Hold down CTRL/CMD to select more than one site type. Note: if you select a major site type (like Stream) you will get its minor site types (canal, ditch and tidal stream) by default even if you do not select them.
|
URL argument name is hasDataTypeCd. Default is all. Restricts results to those sites that collect certain kinds of data. Separate values with commas. Allowed values are:
all - default (see above for qualifications). This is equivalent to &seriesCatalogOutput=true.
iv - Instantaneous values (time-series measurements typically recorded by automated equipment at frequent intervals (e.g., hourly)
uv - Unit values (alias for iv)
rt - Real-time data (alias for iv). Unfortunately, using "rt" may retrieve sites that are not "real-time" because it is simply an alias, e.g. it may show discontinued sites. The closest approximation of a list of real-time sites is to use &siteStatus=active
dv - Daily values (once daily measurements or summarized information for a particular day, such as daily maximum, minimum and mean)
pk - Peaks measurements of water levels and streamflow for surface water sites (such as during floods, may be either an automated or a manual measurement)
sv - Site visits (irregular manual surface water measurements, excluding peak measurements)
gw - Groundwater levels measured at irregular, discrete intervals. For recorded, time series groundwater levels, use iv or id.
qw - Water-quality data from discrete sampling events and analyzed in the field or in a laboratory. For recorded time series water-quality data, use iv or id.
id - Historical instantaneous values (sites in the USGS Instantaneous Data Archive )
aw - Sites monitored by the USGS Active Groundwater Level Network
ad - Sites included in USGS Annual Water Data Reports
Example: &hasDataTypeCd=dv,iv
|
URL argument name is modifiedSince. Returns only sites whose attributes or period of record data have changed during the requested period. The modifiedSince time period always begins with today and moves toward the past. Use the ISO-8601 duration format . If the modifiedSince argument is not specified in the generated URL, it has no effect on the query.
If you request period of record data (&seriesCatalogOutput=true) or specific data types to be output (outputDataTypeCd), the period of record dates will be examined and, if newer, the newest date will be used to indicate if the site was modified. Otherwise, the date a site's attributes were last changed will be used.
Partial URL examples:
- ?stateCd=NY&modifiedSince=P1M - NY sites are retrieved only if any of their site leel attributes were changed in the last month.
- ?stateCd=NY&seriesCatalogOutput=true&modifiedSince=P1M NY sites are retrieved only if any of their site level attributes or period of record information were changed in the last month.
- ?stateCd=NY&outputDataTypeCd=all&modifiedSince=P1M NY sites are retrieved only if any of their site level attributes or period of record information were changed in the last month.
- ?stateCd=NY&outputDataTypeCd=iv,dv&modifiedSince=P1M NY sites are retrieved only if any of their site level attributes or period of record information for instantaneous values or daily values were changed in the last month.
- ?stateCd=NY&outputDataTypeCd=iv,dv&hasDataTypeCd=pk&modifiedSince=P1M NY sites are retrieved only if any of their site level attributes or period of record information for instantaneous values or daily values were changed in the last month. However, since this query only shows sites where peaks were measured, the sites have to show peaks and also record instantaneous values and/or daily values. The period of record's last changed date for instantaneous and daily values for these sites are then factored into whether a site's information has changed.
|
URL argument names are variable or parameterCd. In this case, parameterCd means a USGS parameter, and indicates some aspect of the site being measured or calculated, such as streamflow. Either parameterCd or variable can be used. If parameterCd or variable is specified in the generated URL, only sites serving those parameters are returned. To specify more than one parameter code, separate with commas, ex: &variable=00060,00065. Complete list of parameter codes . There is no limit on the number of parameter codes allowed per request. The default is all, which can be specified if desired, ex: &variable=all.
|
URL argument name is agencyCd, which indicates the organization maintaining or funding the sites. You can filter to show only sites for a specific agency code. For example, ?stateCd=tx&agencyCd=USCE would return sites in Texas for the U.S. Army Corps of Engineers only. By default if agencyCd does not appear in the URL then sites with any agency code are returned. Agency codes are 3-5 characters long with most being 5 characters in length. List of agency codes .
|
:
:
URL argument names are altMin and altMax. Enter the minimum and/or maximum altitude in feet for the sites you want retrieved. If both are specified, altitudes between the minimum and maximum altitudes are included.
Maximum altitude must be greater than or equal to minimum altitude. Values are inclusive, so if you specify altMin at 1000 feet, you will get sites at exactly 1000 feet or more. Selecting sites based on a desired altitude datum is presently not possible. If you leave these arguments blank, site altitude is ignored. Example: ?altMin=1000&altMax=1500. |
Parameter name is
aquiferCd. Use this to filter sites that exist in specified national aquifers.
Note: not all sites have been associated with national aquifers. Enter one or more national aquifer codes, separated by commas. A national aquifer code is exactly 10 characters. A complete list of national aquifer codes can be found
here. Example:
&aquiferCd=S500EDRTRN,N100HGHPLN returns groundwater sites for the Edwards-Trinity aquifer system and the High Plains national aquifers. The default is
all, which means the results are not filtered to exclude any aquifer codes. It can be specified if desired, however, if a list is provided you cannot exceed 1000 aquifer codes. ex:
&aquiferCd=all.
Parameter name is
localAquiferCd. Use this to filter sites that exist in specified local aquifers.
Note: not all sites have been associated with local aquifers. Enter one or more local aquifer codes in the field, separated by commas. A local aquifer code is 10 characters, beginning with the state's abbreviation followed by a colon followed by the local aquifer code. A complete list of local aquifer codes can be found
here. To translate the state code associated with the local aquifer, you may need
this reference. Example:
&localAquiferCd=AL:111RGLT,AL:111RSDM returns groundwater sites for the Regolith and Saprolite local aquifers in Alabama. The default is
all, which means the results are not filtered to exclude any local aquifer codes. It can be specified if desired, however, if a list is provided you cannot exceed 1000 local aquifer codes. ex:
&localAquiferCd=all.