tsgettoolbox.wdfn_field_measurements#

tsgettoolbox.wdfn_field_measurements(*, geometry: Any = None, id: str = None, field_measurements_series_id: str = None, reading_type: str = None, field_visit_id: str = None, parameter_code: str = None, monitoring_location_id: str = None, observing_procedure_code: str = None, observing_procedure: str = None, value: str = None, unit_of_measure: str = None, time: str = None, qualifier: str = None, vertical_datum: str = None, approval_status: Literal['Provisional', 'Approved'] = None, measuring_agency: str = None, last_modified: str = None, control_condition: str = None, measurement_rated: str = None, year: int = None, month: int = None, day: int = None, time_of_day: str = None, agency_code: str = None, agency_name: str = None, monitoring_location_number: str = None, monitoring_location_name: str = None, district_code: str = None, country_code: str = None, country_name: str = None, state_code: str = None, state_name: str = None, county_code: str = None, county_name: str = None, minor_civil_division_code: str = None, site_type_code: str = None, site_type: str = None, hydrologic_unit_code: str = None, basin_code: str = None, altitude: float = None, altitude_accuracy: float = None, altitude_method_code: str = None, altitude_method_name: str = None, vertical_datum_site: str = None, vertical_datum_name: str = None, horizontal_positional_accuracy_code: str = None, horizontal_positional_accuracy: str = None, horizontal_position_method_code: str = None, horizontal_position_method_name: str = None, original_horizontal_datum: str = None, original_horizontal_datum_name: str = None, drainage_area: float = None, contributing_drainage_area: float = None, time_zone_abbreviation: str = None, uses_daylight_savings: str = None, construction_date: str = None, aquifer_code: str = None, national_aquifer_code: str = None, aquifer_type_code: str = None, well_constructed_depth: float = None, hole_constructed_depth: float = None, depth_source_code: str = None, ts_return_style: Literal['compact', 'full'] = 'compact')#

US:station::E:USGS WDFN Field measurements as time-series

Field measurements are physically measured values collected during a visit to the monitoring location. Field measurements consist of measurements of gage height and discharge, and readings of groundwater levels, and are primarily used as calibration readings for the automated sensors collecting continuous data. They are collected at a low frequency, and delivery of the data in WDFN may be delayed due to data processing time.

Parameters:

  • geometry – The geometry parameter is used to filter the results by a specific geographic area. The value should be a GeoJSON geometry object.

  • id – A universally unique identifier (UUID) representing a single version of a record. It is not stable over time. Every time the record is refreshed in our database (which may happen as part of normal operations and does not imply any change to the data itself) a new ID will be generated. There may be multiple readings occurring at identical times during a single field visit; to uniquely identify a set of readings over time, use the field_visit_id field.

  • field_measurements_series_id – A unique identifier representing a single collection series. This corresponds to the id field in the field-measurements-metadata endpoint. Collection series are defined as the set of field measurements at a given monitoring location for a single parameter code using a single reading type.

  • reading_type – Distinguishes field-measurement readings from measurements. Readings have a value of ReferencePrimary; measurements are Discharge or MeanGageHeight.

  • field_visit_id – A universally unique identifier (UUID) for the field visit. Multiple measurements may be made during a single field visit.

  • parameter_code – Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/parameter-codes/items).

  • monitoring_location_id – A unique identifier representing a single monitoring location. This corresponds to the id field in the monitoring-locations endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).

  • observing_procedure_code – A short code corresponding to the observing procedure for the field measurement.

  • observing_procedure – Water measurement or water-quality observing procedure descriptions.

  • value – The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision.

  • unit_of_measure – A human-readable description of the units of measurement associated with an observation.

  • time –

    The date an observation represents. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double- dots at start or end). Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../2018-03-18T12:31:12Z”

    • Duration objects: “P1M” for data from the past month or “PT36H” for the last 36 hours

    Only features that have a time that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.

  • qualifier – This field indicates any qualifiers associated with an observation, for instance if a sensor may have been impacted by ice or if values were estimated.

  • vertical_datum – The datum used to determine altitude and vertical position at the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/altitude-datums/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/altitude-datums/items).

  • approval_status – Some of the data that you have obtained from this U.S. Geological Survey database may not have received Director’s approval. Any such data values are qualified as provisional and are subject to revision. Provisional data are released on the condition that neither the USGS nor the United States Government may be held liable for any damages resulting from its use. This field reflects the approval status of each record, and is either “Approved”, meaining processing review has been completed and the data is approved for publication, or “Provisional” and subject to revision. For more information about provisional data, go to [https://waterdata.usgs.gov/provisional-data-statement/](https://waterdata.usgs.gov/provisional-data-statement/).

  • measuring_agency – The agency performing the measurement.

  • last_modified –

    The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed. You can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end). Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../2018-03-18T12:31:12Z”

    • Duration objects: “P1M” for data from the past month or “PT36H” for the last 36 hours

    Only features that have a last_modified that intersects the value of datetime are selected.

  • control_condition – The state of the control feature at the time of observation.

  • measurement_rated – A qualitative estimate of the quality of a measurement.

  • year – The calendar year the field measurement was taken.

  • month – The calendar month the field measurement was taken. If null, the month is unknown.

  • day – The day of the month the field measurement was taken. If null, the day is unknown.

  • time_of_day – The time of day the field measurement was taken. If null, the time of day is unknown.

  • agency_code – The agency that is reporting the data. Agency codes are fixed values assigned by the National Water Information System (NWIS). A list of agency codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/agency-codes/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/agency-codes/items).

  • agency_name – The name of the agency that is reporting the data.

  • monitoring_location_number – Each monitoring location in the USGS data base has a unique 8- to 15-digit identification number.

  • monitoring_location_name – This is the official name of the monitoring location in the database. For well information this can be a district-assigned local number.

  • district_code – The Water Science Centers (WSCs) across the United States use the FIPS state code as the district code. In some case, monitoring locations and samples may be managed by a water science center that is adjacent to the state in which the monitoring location actually resides. For example a monitoring location may have a district code of 30 which translates to Montana, but the state code could be 56 for Wyoming because that is where the monitoring location actually is located.

  • country_code – The code for the country in which the monitoring location is located.

  • country_name – The name of the country in which the monitoring location is located.

  • state_code – State code. A [two-digit ANSI code](https://www2.census.gov/geo/docs/reference/state.txt) (formerly FIPS code) as defined by the American National Standards Institute, to define States and equivalents. A three-digit ANSI code is used to define counties and county equivalents. [A lookup table is available.](https://www.census.gov/library/reference/code- lists/ansi.html#states) The only countries with political subdivisions other than the US are Mexico and Canada. The Mexican states have US state codes ranging from 81-86 and Canadian provinces have state codes ranging from 90-98.

  • state_name – The name of the state or state equivalent in which the monitoring location is located.

  • county_code – The code for the county or county equivalent (parish, borough, etc.) in which the monitoring location is located. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/counties/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/counties/items).

  • county_name – The name of the county or county equivalent (parish, borough, etc.) in which the monitoring location is located. [A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/counties/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/counties/items).

  • minor_civil_division_code – Codes for primary governmental or administrative divisions of the county or county equivalent in which the monitoring location is located.

  • site_type_code – A code describing the hydrologic setting of the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/site-types/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/site-types/items).

  • site_type – A description of the hydrologic setting of the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/site-types/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/site-types/items).

  • hydrologic_unit_code – The hydrologic unit code (HUC) for the monitoring location. Supports prefix matching — querying with a shorter HUC (e.g. “04”) matches all locations within that hydrologic region.

  • basin_code – The Basin Code or “drainage basin code” is a two-digit code that further subdivides the 8-digit hydrologic-unit code. The drainage basin code is defined by the USGS State Office where the monitoring location is located.

  • altitude – Altitude of the monitoring location referenced to the specified Vertical Datum.

  • altitude_accuracy – Accuracy of the altitude, in feet. An accuracy of +/- 0.1 foot would be entered as “.1”. Many altitudes are interpolated from the contours on topographic maps; accuracies determined in this way are generally entered as one-half of the contour interval.

  • altitude_method_code – Codes representing the method used to measure altitude.

  • altitude_method_name – The name of the method used to measure altitude.

  • vertical_datum_site – The vertical datum used to determine altitude at the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/altitude-datums/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/altitude-datums/items).

  • vertical_datum_name – The datum used to determine altitude and vertical position at the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/altitude-datums/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/altitude-datums/items).

  • horizontal_positional_accuracy_code – Indicates the accuracy of the latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-accuracy-codes/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-accuracy-codes/items).

  • horizontal_positional_accuracy – Indicates the accuracy of the latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-accuracy-codes/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-accuracy-codes/items).

  • horizontal_position_method_code – Indicates the method used to determine latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-method-codes/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-method-codes/items).

  • horizontal_position_method_name – Indicates the method used to determine latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-method-codes/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-method-codes/items).

  • original_horizontal_datum – Coordinates are published in EPSG:4326 / WGS84 / World Geodetic System 1984. This field indicates the original datum used to determine coordinates before they were converted. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-datum-codes/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-datum-codes/items).

  • original_horizontal_datum_name – Coordinates are published in EPSG:4326 / WGS84 / World Geodetic System 1984. This field indicates the original datum used to determine coordinates before they were converted. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-datum-codes/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-datum-codes/items).

  • drainage_area – The area enclosed by a topographic divide from which direct surface runoff from precipitation normally drains by gravity into the stream above that point.

  • contributing_drainage_area – The contributing drainage area of a lake, stream, wetland, or estuary monitoring location, in square miles. This item should be present only if the contributing area is different from the total drainage area. This situation can occur when part of the drainage area consists of very porous soil or depressions that either allow all runoff to enter the groundwater or traps the water in ponds so that rainfall does not contribute to runoff. A transbasin diversion can also affect the total drainage area.

  • time_zone_abbreviation – A short code describing the time zone used by a monitoring location.

  • uses_daylight_savings – A flag indicating whether or not a monitoring location uses daylight savings.

  • construction_date – Date the well was completed.

  • aquifer_code – Local aquifers in the USGS water resources data base are identified by a geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name).

  • national_aquifer_code – National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water. Not all groundwater monitoring locations can be associated with a National Aquifer. Such monitoring locations will not be retrieved using this search criteria. A list of National aquifer codes and names is available at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/national-aquifer-codes/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/national-aquifer-codes/items).

  • aquifer_type_code – Describes the confinement status of an aquifer at the monitoring location. A confined aquifer is an aquifer below the land surface that is saturated with water. A water table–or unconfined–aquifer is an aquifer whose upper water surface (water table) is at atmospheric pressure, and thus is able to rise and fall.

  • well_constructed_depth – The depth of the finished well, in feet below land surface datum. Note: Not all groundwater monitoring locations have information on Well Depth. Such monitoring locations will not be retrieved using this search criteria.

  • hole_constructed_depth – The total depth to which the hole is drilled, in feet below land surface datum. Note: Not all groundwater monitoring locations have information on Hole Depth. Such monitoring locations will not be retrieved using this search criteria.

  • depth_source_code – A code indicating the source of water-level data.

  • ts_return_style – Return style, either ‘compact’ or ‘full’