{ "opencollection": "1.0.0", "info": { "name": "USGS Water Data OGC APIs agency-codes field-measurements API", "version": "0.56.0" }, "items": [ { "info": { "name": "field-measurements", "type": "folder" }, "items": [ { "info": { "name": "Get Field measurements metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements", "params": [ { "name": "f", "value": "", "type": "query", "description": "The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available." }, { "name": "lang", "value": "", "type": "query", "description": "The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. \"fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7\"), simple (e.g. \"de\") or locale-like (e.g. \"de-CH\" or \"fr_BE\") fashion." } ] }, "docs": "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.\n" }, { "info": { "name": "Get Field measurements items", "type": "http" }, "http": { "method": "GET", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements/items", "params": [ { "name": "f", "value": "", "type": "query", "description": "The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON." }, { "name": "lang", "value": "", "type": "query", "description": "The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. \"fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7\"), simple (e.g. \"de\") or locale-like (e.g. \"de-CH\" or \"fr_BE\") fashion." }, { "name": "bbox", "value": "", "type": "query", "description": "Only features that have a geometry that intersects the bounding box are selected.The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth)." }, { "name": "limit", "value": "", "type": "query", "description": "The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10)." }, { "name": "crs", "value": "", "type": "query", "description": "Indicates the coordinate reference system for the results." }, { "name": "bbox-crs", "value": "", "type": "query", "description": "Indicates the coordinate reference system for the given bbox coordinates." }, { "name": "properties", "value": "", "type": "query", "description": "The properties that should be included. The parameter value is a comma-separated list of property names." }, { "name": "skipGeometry", "value": "", "type": "query", "description": "This option can be used to skip response geometries for each feature." }, { "name": "sortby", "value": "", "type": "query", "description": "Specifies a comma-separated list of property names by which the response shall be sorted. If the property name is preceded by a plus (+) sign it indicates an ascending sort for that property. If the property name is preceded by a minus (-) sign it indicates a descending sort for that property. If the property is not preceded by a plus or minus, then the default sort order implied is ascending (+). \n\nOnly a single page of data can be returned when specifying sortby. If you need more than a single page of data, don't specify a sortby value and sort the full data set after it's been downloaded." }, { "name": "offset", "value": "", "type": "query", "description": "The optional offset parameter indicates the index within the result set from which the server shall begin presenting results in the response document. The first element has an index of 0 (default)." }, { "name": "field_measurements_series_id", "value": "", "type": "query", "description": "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.\n" }, { "name": "reading_type", "value": "", "type": "query", "description": "Distinguishes field-measurement readings from measurements. Readings have a value of ReferencePrimary; measurements are Discharge or MeanGageHeight.\n" }, { "name": "field_visit_id", "value": "", "type": "query", "description": "A universally unique identifier (UUID) for the field visit. Multiple measurements may be made during a single field visit.\n" }, { "name": "parameter_code", "value": "", "type": "query", "description": "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/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas." }, { "name": "monitoring_location_id", "value": "", "type": "query", "description": "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).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas." }, { "name": "observing_procedure_code", "value": "", "type": "query", "description": "A short code corresponding to the observing procedure for the field measurement." }, { "name": "observing_procedure", "value": "", "type": "query", "description": "Water measurement or water-quality observing procedure descriptions." }, { "name": "value", "value": "", "type": "query", "description": "The value of the observation. Values are transmitted as strings in the JSON response format in order to preserve precision.\n" }, { "name": "unit_of_measure", "value": "", "type": "query", "description": "A human-readable description of the units of measurement associated with an observation." }, { "name": "time", "value": "", "type": "query", "description": "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).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly 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.\n" }, { "name": "qualifier", "value": "", "type": "query", "description": "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.\n" }, { "name": "vertical_datum", "value": "", "type": "query", "description": "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/v0/collections/altitude-datums/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items).\n" }, { "name": "approval_status", "value": "", "type": "query", "description": "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/).\n" }, { "name": "measuring_agency", "value": "", "type": "query", "description": "The agency performing the measurement." }, { "name": "last_modified", "value": "", "type": "query", "description": "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.\nYou 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).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n" }, { "name": "control_condition", "value": "", "type": "query", "description": "The state of the control feature at the time of observation.\n" }, { "name": "measurement_rated", "value": "", "type": "query", "description": "A qualitative estimate of the quality of a measurement.\n" }, { "name": "year", "value": "", "type": "query", "description": "The calendar year the field measurement was taken.\n" }, { "name": "month", "value": "", "type": "query", "description": "The calendar month the field measurement was taken. If null, the month is unknown.\n" }, { "name": "day", "value": "", "type": "query", "description": "The day of the month the field measurement was taken. If null, the day is unknown.\n" }, { "name": "time_of_day", "value": "", "type": "query", "description": "The time of day the field measurement was taken. If null, the time of day is unknown.\n" }, { "name": "agency_code", "value": "", "type": "query", "description": "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/v0/collections/agency-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/agency-codes/items).\n" }, { "name": "agency_name", "value": "", "type": "query", "description": "The name of the agency that is reporting the data.\n" }, { "name": "altitude", "value": "", "type": "query" }, { "name": "altitude_accuracy", "value": "", "type": "query" }, { "name": "altitude_method_code", "value": "", "type": "query" }, { "name": "altitude_method_name", "value": "", "type": "query" }, { "name": "aquifer_code", "value": "", "type": "query" }, { "name": "aquifer_type_code", "value": "", "type": "query" }, { "name": "basin_code", "value": "", "type": "query" }, { "name": "construction_date", "value": "", "type": "query" }, { "name": "contributing_drainage_area", "value": "", "type": "query" }, { "name": "country_code", "value": "", "type": "query" }, { "name": "country_name", "value": "", "type": "query" }, { "name": "county_code", "value": "", "type": "query", "description": "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/v0/collections/counties/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/counties/items).\n" }, { "name": "county_name", "value": "", "type": "query", "description": "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/v0/collections/counties/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/counties/items).\n" }, { "name": "depth_source_code", "value": "", "type": "query" }, { "name": "district_code", "value": "", "type": "query", "description": "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.\n" }, { "name": "drainage_area", "value": "", "type": "query" }, { "name": "hole_constructed_depth", "value": "", "type": "query" }, { "name": "horizontal_position_method_code", "value": "", "type": "query" }, { "name": "horizontal_position_method_name", "value": "", "type": "query" }, { "name": "horizontal_positional_accuracy", "value": "", "type": "query" }, { "name": "horizontal_positional_accuracy_code", "value": "", "type": "query" }, { "name": "hydrologic_unit_code", "value": "", "type": "query", "description": "The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. The hydrologic units are arranged within each other, from the smallest (cataloging units) to the largest (regions). Each hydrologic unit is identified by a unique hydrologic unit code (HUC) consisting of two to eight digits based on the four levels of classification in the hydrologic unit system.\n Search will match partial HUCs." }, { "name": "minor_civil_division_code", "value": "", "type": "query" }, { "name": "monitoring_location_name", "value": "", "type": "query", "description": "This is the official name of the monitoring location in the database. For well information this can be a district-assigned local number.\n" }, { "name": "monitoring_location_number", "value": "", "type": "query", "description": "Each monitoring location in the USGS data base has a unique 8- to 15-digit identification number.\n" }, { "name": "national_aquifer_code", "value": "", "type": "query" }, { "name": "original_horizontal_datum", "value": "", "type": "query" }, { "name": "original_horizontal_datum_name", "value": "", "type": "query" }, { "name": "site_type", "value": "", "type": "query", "description": "A description of the hydrologic setting of the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items).\n" }, { "name": "site_type_code", "value": "", "type": "query", "description": "A code describing the hydrologic setting of the monitoring location. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items).\n" }, { "name": "state_code", "value": "", "type": "query", "description": "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.\n" }, { "name": "state_name", "value": "", "type": "query", "description": "The name of the state or state equivalent in which the monitoring location is located.\n" }, { "name": "time_zone_abbreviation", "value": "", "type": "query" }, { "name": "uses_daylight_savings", "value": "", "type": "query" }, { "name": "vertical_datum_name", "value": "", "type": "query" }, { "name": "vertical_datum_site", "value": "", "type": "query" }, { "name": "well_constructed_depth", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query", "description": "CQL Text filter expression. CQL JSON cannot be used here, only in the body. \nSee also: https://docs.pygeoapi.io/en/latest/cql.html \n\nExample: time_series_id IN ('64ee32f5350a4ec4967435dcd2e364ea', '3e55d9c2d8a54bec9ca5e292b07d5a96')" } ], "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "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.\n" }, { "info": { "name": "Get Field measurements items with CQL2", "type": "http" }, "http": { "method": "POST", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements/items", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "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.\n" }, { "info": { "name": "Options for Field measurements items", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements/items", "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "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.\n" }, { "info": { "name": "Get Field measurements item by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements/items/:featureId", "params": [ { "name": "crs", "value": "", "type": "query", "description": "Indicates the coordinate reference system for the results." }, { "name": "f", "value": "", "type": "query", "description": "The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available." }, { "name": "lang", "value": "", "type": "query", "description": "The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. \"fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7\"), simple (e.g. \"de\") or locale-like (e.g. \"de-CH\" or \"fr_BE\") fashion." } ], "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "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.\n" }, { "info": { "name": "Options for Field measurements item by id", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements/items/:featureId", "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "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.\n" }, { "info": { "name": "Get Field measurements queryables", "type": "http" }, "http": { "method": "GET", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements/queryables", "params": [ { "name": "properties", "value": "", "type": "query", "description": "The properties that should be included. The parameter value is a comma-separated list of property names." }, { "name": "f", "value": "", "type": "query", "description": "The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available." }, { "name": "profile", "value": "", "type": "query", "description": "The profile to be applied to a given request" }, { "name": "lang", "value": "", "type": "query", "description": "The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. \"fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7\"), simple (e.g. \"de\") or locale-like (e.g. \"de-CH\" or \"fr_BE\") fashion." } ], "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "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.\n" }, { "info": { "name": "Get Field measurements schema", "type": "http" }, "http": { "method": "GET", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements/schema", "params": [ { "name": "f", "value": "", "type": "query", "description": "The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available." }, { "name": "lang", "value": "", "type": "query", "description": "The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. \"fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7\"), simple (e.g. \"de\") or locale-like (e.g. \"de-CH\" or \"fr_BE\") fashion." } ], "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "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.\n" } ] } ], "bundled": true }