openapi: 3.0.2 info: contact: name: US Geological Survey - Water Data for the Nation url: https://waterdata.usgs.gov x-ogc-serviceContact: addresses: [] emails: - value: wdfn@usgs.gov hoursOfService: pointOfContact links: - href: https://waterdata.usgs.gov/questions-comments/?referrerUrl=https://api.waterdata.usgs.gov type: text/html name: WDFN Support description: 'These APIs provide OGC-compliant interfaces to USGS water data, letting you download continuous sensor measurements, discrete field measurements, metadata about monitoring locations, and more. ' license: name: US Government work in the public domain url: https://creativecommons.org/publicdomain/zero/1.0/ termsOfService: https://creativecommons.org/publicdomain/zero/1.0/ title: USGS Water Data OGC APIs agency-codes combined-metadata API version: 0.56.0 x-keywords: - geospatial - data - api - hydrology - USGS servers: - description: 'These APIs provide OGC-compliant interfaces to USGS water data, letting you download continuous sensor measurements, discrete field measurements, metadata about monitoring locations, and more. ' url: https://api.waterdata.usgs.gov/ogcapi/v0 tags: - description: 'This endpoint combines metadata from timeseries and field measurements collections by site. ' name: combined-metadata paths: /collections/combined-metadata: get: description: 'This endpoint combines metadata from timeseries and field measurements collections by site. ' operationId: describeCombined-metadataCollection parameters: - $ref: '#/components/parameters/f' - $ref: '#/components/parameters/lang' responses: '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Collection '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter '403': $ref: '#/components/responses/Forbidden403' '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound '429': $ref: '#/components/responses/TooManyRequests429' '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError summary: Get Combined metadata metadata tags: - combined-metadata /collections/combined-metadata/items: get: description: 'This endpoint combines metadata from timeseries and field measurements collections by site. ' operationId: getCombined-metadataFeatures parameters: - 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. explode: false in: query name: f required: false schema: default: json enum: - json - html - jsonld - csv type: string style: form - $ref: '#/components/parameters/lang' - $ref: '#/components/parameters/bbox' - description: The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10). explode: false in: query name: limit required: false schema: default: 10 maximum: 50000 minimum: 1 type: integer style: form - $ref: '#/components/parameters/crs' - $ref: '#/components/parameters/bbox-crs' - description: The properties that should be included. The parameter value is a comma-separated list of property names. explode: false in: query name: properties required: false schema: items: enum: - monitoring_location_id - agency_code - agency_name - monitoring_location_number - monitoring_location_name - district_code - country_code - country_name - state_code - state_name - county_code - county_name - minor_civil_division_code - site_type_code - site_type - hydrologic_unit_code - basin_code - altitude - altitude_accuracy - altitude_method_code - altitude_method_name - vertical_datum - vertical_datum_name - horizontal_positional_accuracy_code - horizontal_positional_accuracy - horizontal_position_method_code - horizontal_position_method_name - original_horizontal_datum - original_horizontal_datum_name - drainage_area - contributing_drainage_area - time_zone_abbreviation - uses_daylight_savings - construction_date - aquifer_code - national_aquifer_code - aquifer_type_code - well_constructed_depth - hole_constructed_depth - depth_source_code - id - unit_of_measure - parameter_name - parameter_code - statistic_id - last_modified - begin - end - data_type - computation_identifier - thresholds - sublocation_identifier - primary - web_description - parameter_description - parent_time_series_id type: string type: array style: form - $ref: '#/components/parameters/skipGeometry' - $ref: '#/components/parameters/wda_sortby' - $ref: '#/components/parameters/offset' - 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." explode: false in: query name: monitoring_location_id required: false schema: 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." title: Monitoring location ID type: string style: form - 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). ' explode: false in: query name: agency_code required: false schema: 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). ' title: Agency code type: string style: form - description: 'The name of the agency that is reporting the data. ' explode: false in: query name: agency_name required: false schema: description: 'The name of the agency that is reporting the data. ' title: Agency name type: string style: form - description: 'Each monitoring location in the USGS data base has a unique 8- to 15-digit identification number. ' explode: false in: query name: monitoring_location_number required: false schema: description: 'Each monitoring location in the USGS data base has a unique 8- to 15-digit identification number. ' title: Monitoring location number type: string style: form - description: 'This is the official name of the monitoring location in the database. For well information this can be a district-assigned local number. ' explode: false in: query name: monitoring_location_name required: false schema: description: 'This is the official name of the monitoring location in the database. For well information this can be a district-assigned local number. ' title: Monitoring location name type: string style: form - 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. ' explode: false in: query name: district_code required: false schema: 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. ' title: District code type: string style: form - description: 'The code for the country in which the monitoring location is located. ' explode: false in: query name: country_code required: false schema: description: 'The code for the country in which the monitoring location is located. ' title: Country code type: string style: form - description: 'The name of the country in which the monitoring location is located. ' explode: false in: query name: country_name required: false schema: description: 'The name of the country in which the monitoring location is located. ' title: Country name type: string style: form - 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. ' explode: false in: query name: state_code required: false schema: 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. ' title: State code type: string style: form - description: 'The name of the state or state equivalent in which the monitoring location is located. ' explode: false in: query name: state_name required: false schema: description: 'The name of the state or state equivalent in which the monitoring location is located. ' title: State name type: string style: form - 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). ' explode: false in: query name: county_code required: false schema: 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). ' title: County code type: string style: form - 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). ' explode: false in: query name: county_name required: false schema: 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). ' title: County name type: string style: form - description: 'Codes for primary governmental or administrative divisions of the county or county equivalent in which the monitoring location is located. ' explode: false in: query name: minor_civil_division_code required: false schema: description: 'Codes for primary governmental or administrative divisions of the county or county equivalent in which the monitoring location is located. ' title: Minor civil division code type: string style: form - 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). ' explode: false in: query name: site_type_code required: false schema: 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). ' title: Monitoring location type code type: string style: form - 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). ' explode: false in: query name: site_type required: false schema: 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). ' title: Monitoring location type type: string style: form - 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." explode: false in: query name: hydrologic_unit_code required: false schema: 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." title: Hydrologic unit code (HUC) type: string style: form - description: '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. ' explode: false in: query name: basin_code required: false schema: description: '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. ' title: Basin code type: string style: form - description: 'Altitude of the monitoring location referenced to the specified Vertical Datum. ' explode: false in: query name: altitude required: false schema: description: 'Altitude of the monitoring location referenced to the specified Vertical Datum. ' title: Altitude type: number style: form - description: '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. ' explode: false in: query name: altitude_accuracy required: false schema: description: '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. ' title: Altitude accuracy type: number style: form - description: 'Codes representing the method used to measure altitude. ' explode: false in: query name: altitude_method_code required: false schema: description: 'Codes representing the method used to measure altitude. ' title: Altitude method code type: string style: form - description: 'The name of the method used to measure altitude. ' explode: false in: query name: altitude_method_name required: false schema: description: 'The name of the method used to measure altitude. ' title: Altitude method name type: string style: form - 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). ' explode: false in: query name: vertical_datum required: false schema: 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). ' title: Vertical datum type: string style: form - 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). ' explode: false in: query name: vertical_datum_name required: false schema: 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). ' title: Vertical datum name type: string style: form - description: 'Indicates the accuracy of the latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items). ' explode: false in: query name: horizontal_positional_accuracy_code required: false schema: description: 'Indicates the accuracy of the latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items). ' title: Horizontal positional accuracy code type: string style: form - description: 'Indicates the accuracy of the latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items). ' explode: false in: query name: horizontal_positional_accuracy required: false schema: description: 'Indicates the accuracy of the latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items). ' title: Horizontal positional accuracy type: string style: form - description: 'Indicates the method used to determine latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items). ' explode: false in: query name: horizontal_position_method_code required: false schema: description: 'Indicates the method used to determine latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items). ' title: Horizontal position method code type: string style: form - description: 'Indicates the method used to determine latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items). ' explode: false in: query name: horizontal_position_method_name required: false schema: description: 'Indicates the method used to determine latitude longitude values. A list of codes is available at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items). ' title: Horizontal position method name type: string style: form - description: '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/v0/collections/coordinate-datum-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items). ' explode: false in: query name: original_horizontal_datum required: false schema: description: '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/v0/collections/coordinate-datum-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items). ' title: Original horizontal datum type: string style: form - description: '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/v0/collections/coordinate-datum-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items). ' explode: false in: query name: original_horizontal_datum_name required: false schema: description: '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/v0/collections/coordinate-datum-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items). ' title: Original horizontal datum name type: string style: form - description: 'The area enclosed by a topographic divide from which direct surface runoff from precipitation normally drains by gravity into the stream above that point. ' explode: false in: query name: drainage_area required: false schema: description: 'The area enclosed by a topographic divide from which direct surface runoff from precipitation normally drains by gravity into the stream above that point. ' title: Drainage area type: number style: form - description: '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. ' explode: false in: query name: contributing_drainage_area required: false schema: description: '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. ' title: Contributing drainage area type: number style: form - description: 'A short code describing the time zone used by a monitoring location. ' explode: false in: query name: time_zone_abbreviation required: false schema: description: 'A short code describing the time zone used by a monitoring location. ' title: Time zone abbreviation type: string style: form - description: 'A flag indicating whether or not a monitoring location uses daylight savings. ' explode: false in: query name: uses_daylight_savings required: false schema: description: 'A flag indicating whether or not a monitoring location uses daylight savings. ' title: Uses daylight savings flag type: string style: form - description: 'Date the well was completed. ' explode: false in: query name: construction_date required: false schema: description: 'Date the well was completed. ' title: Construction date type: string style: form - description: '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). ' explode: false in: query name: aquifer_code required: false schema: description: '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). ' title: Aquifer code type: string style: form - description: '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/v0/collections/national-aquifer-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/national-aquifer-codes/items). ' explode: false in: query name: national_aquifer_code required: false schema: description: '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/v0/collections/national-aquifer-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/national-aquifer-codes/items). ' title: National aquifer code type: string style: form - description: '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. ' explode: false in: query name: aquifer_type_code required: false schema: description: '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. ' title: Aquifer type code type: string style: form - description: '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. ' explode: false in: query name: well_constructed_depth required: false schema: description: '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. ' title: Well constructed depth type: number style: form - description: '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. ' explode: false in: query name: hole_constructed_depth required: false schema: description: '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. ' title: Hole constructed depth type: number style: form - description: 'A code indicating the source of water-level data. ' explode: false in: query name: depth_source_code required: false schema: description: 'A code indicating the source of water-level data. ' title: Depth source code type: string style: form - description: The ID of the time series or field measurement series (identified by `data_type`) that collection metadata corresponds to. Split parameters are enabled for this field, so you can supply multiple values separated by commas. explode: false in: query name: id required: false schema: description: The ID of the time series or field measurement series (identified by `data_type`) that collection metadata corresponds to. Split parameters are enabled for this field, so you can supply multiple values separated by commas. title: Data series ID type: string style: form - description: A human-readable description of the units of measurement associated with an observation. explode: false in: query name: unit_of_measure required: false schema: description: A human-readable description of the units of measurement associated with an observation. title: Unit of measure type: string style: form - description: A human-understandable name corresponding to `parameter_code`. explode: false in: query name: parameter_name required: false schema: description: A human-understandable name corresponding to `parameter_code`. title: Parameter name type: string style: form - 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." explode: false in: query name: parameter_code required: false schema: 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." title: Parameter code type: string style: form - description: "A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas." explode: false in: query name: statistic_id required: false schema: description: "A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas." title: Statistic ID type: string style: form - 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" explode: false in: query name: last_modified required: false schema: 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" title: Last modified date type: string style: form - description: "The datetime of the earliest observation in the time series. Together with `end_utc`, this field represents the period of record of a time series. Note that some time series may have large gaps in their collection record.\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 `begin_utc` that intersects the value of datetime are selected.\n" explode: false in: query name: begin required: false schema: description: "The datetime of the earliest observation in the time series. Together with `end_utc`, this field represents the period of record of a time series. Note that some time series may have large gaps in their collection record.\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 `begin_utc` that intersects the value of datetime are selected.\n" title: Time series first observation timestamp - UTC type: string style: form - description: "The datetime of the most recent observation in the time series. Data returned by this endpoint updates at most once per day, and potentially less frequently than that, and as such there may be more recent observations within a time series than the time series `end_utc` value reflects. Together with `begin_utc`, this field represents the period of record of a time series. It is additionally used to determine whether a time series is \"active\".\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 `end_utc` that intersects the value of datetime are selected.\n" explode: false in: query name: end required: false schema: description: "The datetime of the most recent observation in the time series. Data returned by this endpoint updates at most once per day, and potentially less frequently than that, and as such there may be more recent observations within a time series than the time series `end_utc` value reflects. Together with `begin_utc`, this field represents the period of record of a time series. It is additionally used to determine whether a time series is \"active\".\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 `end_utc` that intersects the value of datetime are selected.\n" title: Time series most recent observation timestamp - UTC type: string style: form - description: The computational period type of data collected at the monitoring location. Split parameters are enabled for this field, so you can supply multiple values separated by commas. explode: false in: query name: data_type required: false schema: description: The computational period type of data collected at the monitoring location. Split parameters are enabled for this field, so you can supply multiple values separated by commas. title: Data type type: string style: form - description: Indicates the computation performed to calculate this time series. Values of "Instantaneous" reflect point measurements. Split parameters are enabled for this field, so you can supply multiple values separated by commas. explode: false in: query name: computation_identifier required: false schema: description: Indicates the computation performed to calculate this time series. Values of "Instantaneous" reflect point measurements. Split parameters are enabled for this field, so you can supply multiple values separated by commas. title: Computation identifier type: string style: form - description: 'Thresholds represent known numeric limits for a time series, for example the historic maximum value for a parameter or a level below which a sensor is non-operative. These thresholds are sometimes used to automatically determine if an observation is erroneous due to sensor error, and therefore shouldn''t be included in the time series. ' explode: false in: query name: thresholds required: false schema: description: 'Thresholds represent known numeric limits for a time series, for example the historic maximum value for a parameter or a level below which a sensor is non-operative. These thresholds are sometimes used to automatically determine if an observation is erroneous due to sensor error, and therefore shouldn''t be included in the time series. ' title: Operational thresholds type: string style: form - description: 'An optional human-readable identifier used to specify where measurements are recorded at a monitoring location. ' explode: false in: query name: sublocation_identifier required: false schema: description: 'An optional human-readable identifier used to specify where measurements are recorded at a monitoring location. ' title: Sublocation identifier type: string style: form - description: 'A flag identifying if the time series is a "primary" time series. "Primary" time series (which have this flag) are standard observations which undergo [Bureau review and approval processes](https://www.usgs.gov/survey-manual/5028-fundamental-science-practices-review-and-approval-scientific-data-release). Non-primary time series, which will have missing values for "primary", are provisional datasets made available to meet the need for timely best science and to assist with daily operations which need real-time information. Non-primary time series data are only retained by this system for 120 days. See the [USGS Provisional Data Statement](https://waterdata.usgs.gov/provisional-data-statement/) for more information. ' explode: false in: query name: primary required: false schema: description: 'A flag identifying if the time series is a "primary" time series. "Primary" time series (which have this flag) are standard observations which undergo [Bureau review and approval processes](https://www.usgs.gov/survey-manual/5028-fundamental-science-practices-review-and-approval-scientific-data-release). Non-primary time series, which will have missing values for "primary", are provisional datasets made available to meet the need for timely best science and to assist with daily operations which need real-time information. Non-primary time series data are only retained by this system for 120 days. See the [USGS Provisional Data Statement](https://waterdata.usgs.gov/provisional-data-statement/) for more information. ' title: Primary flag type: string style: form - description: 'An optional description of the time series. WDFN and other USGS data dissemination products use this field, in combination with sublocation_identifier, to distinguish the differences between multiple time series for the same parameter code, statistic code, and monitoring location. ' explode: false in: query name: web_description required: false schema: description: 'An optional description of the time series. WDFN and other USGS data dissemination products use this field, in combination with sublocation_identifier, to distinguish the differences between multiple time series for the same parameter code, statistic code, and monitoring location. ' title: Time series description type: string style: form - description: 'A description of what the parameter code represents, as used by WDFN and other USGS data dissemination products. ' explode: false in: query name: parameter_description required: false schema: description: 'A description of what the parameter code represents, as used by WDFN and other USGS data dissemination products. ' title: Parameter description type: string style: form - description: 'The unique identifier representing the parent or "upchain" time series that a daily values time series is generated from. Daily values time series have one and only one parent time series. ' explode: false in: query name: parent_time_series_id required: false schema: description: 'The unique identifier representing the parent or "upchain" time series that a daily values time series is generated from. Daily values time series have one and only one parent time series. ' title: Parent time series ID type: string style: form - $ref: '#/components/parameters/filter' responses: '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter '403': $ref: '#/components/responses/Forbidden403' '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound '429': $ref: '#/components/responses/TooManyRequests429' '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError security: - ApiKeyQuery: [] - ApiKeyHeader: [] summary: Get Combined metadata items tags: - combined-metadata options: description: 'This endpoint combines metadata from timeseries and field measurements collections by site. ' operationId: optionsCombined-metadataFeatures responses: '200': description: options response security: - ApiKeyQuery: [] - ApiKeyHeader: [] summary: Options for Combined metadata items tags: - combined-metadata post: description: 'This endpoint combines metadata from timeseries and field measurements collections by site. ' operationId: getCQL2Combined-metadataFeatures requestBody: content: application/json: schema: $ref: https://schemas.opengis.net/cql2/1.0/cql2.json description: Get items with CQL2 required: true responses: '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Features '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter '403': $ref: '#/components/responses/Forbidden403' '429': $ref: '#/components/responses/TooManyRequests429' '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError security: - ApiKeyQuery: [] - ApiKeyHeader: [] summary: Get Combined metadata items with CQL2 tags: - combined-metadata /collections/combined-metadata/items/{featureId}: get: description: 'This endpoint combines metadata from timeseries and field measurements collections by site. ' operationId: getCombined-metadataFeature parameters: - $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId - $ref: '#/components/parameters/crs' - $ref: '#/components/parameters/f' - $ref: '#/components/parameters/lang' responses: '200': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/Feature '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter '403': $ref: '#/components/responses/Forbidden403' '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound '429': $ref: '#/components/responses/TooManyRequests429' '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError security: - ApiKeyQuery: [] - ApiKeyHeader: [] summary: Get Combined metadata item by id tags: - combined-metadata options: description: 'This endpoint combines metadata from timeseries and field measurements collections by site. ' operationId: optionsCombined-metadataFeature parameters: - $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/parameters/featureId responses: '200': description: options response security: - ApiKeyQuery: [] - ApiKeyHeader: [] summary: Options for Combined metadata item by id tags: - combined-metadata /collections/combined-metadata/queryables: get: description: 'This endpoint combines metadata from timeseries and field measurements collections by site. ' operationId: getCombined-metadataQueryables parameters: - description: The properties that should be included. The parameter value is a comma-separated list of property names. explode: false in: query name: properties required: false schema: items: enum: - monitoring_location_id - agency_code - agency_name - monitoring_location_number - monitoring_location_name - district_code - country_code - country_name - state_code - state_name - county_code - county_name - minor_civil_division_code - site_type_code - site_type - hydrologic_unit_code - basin_code - altitude - altitude_accuracy - altitude_method_code - altitude_method_name - vertical_datum - vertical_datum_name - horizontal_positional_accuracy_code - horizontal_positional_accuracy - horizontal_position_method_code - horizontal_position_method_name - original_horizontal_datum - original_horizontal_datum_name - drainage_area - contributing_drainage_area - time_zone_abbreviation - uses_daylight_savings - construction_date - aquifer_code - national_aquifer_code - aquifer_type_code - well_constructed_depth - hole_constructed_depth - depth_source_code - id - unit_of_measure - parameter_name - parameter_code - statistic_id - last_modified - begin - end - data_type - computation_identifier - thresholds - sublocation_identifier - primary - web_description - parameter_description - parent_time_series_id type: string type: array style: form - $ref: '#/components/parameters/f' - description: The profile to be applied to a given request explode: false in: query name: profile required: false schema: enum: - actual-domain - valid-domain type: string style: form - $ref: '#/components/parameters/lang' responses: '200': $ref: '#/components/responses/Queryables' '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter '403': $ref: '#/components/responses/Forbidden403' '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound '429': $ref: '#/components/responses/TooManyRequests429' '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError security: - ApiKeyQuery: [] - ApiKeyHeader: [] summary: Get Combined metadata queryables tags: - combined-metadata /collections/combined-metadata/schema: get: description: 'This endpoint combines metadata from timeseries and field measurements collections by site. ' operationId: getCombined-metadataSchema parameters: - $ref: '#/components/parameters/f' - $ref: '#/components/parameters/lang' responses: '200': $ref: '#/components/responses/Queryables' '400': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/InvalidParameter '403': $ref: '#/components/responses/Forbidden403' '404': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/NotFound '429': $ref: '#/components/responses/TooManyRequests429' '500': $ref: https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/ogcapi-features-1.yaml#/components/responses/ServerError security: - ApiKeyQuery: [] - ApiKeyHeader: [] summary: Get Combined metadata schema tags: - combined-metadata components: parameters: offset: 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). explode: false in: query name: offset required: false schema: default: 0 minimum: 0 type: integer style: form skipGeometry: description: This option can be used to skip response geometries for each feature. explode: false in: query name: skipGeometry required: false schema: default: false type: boolean style: form f: 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. explode: false in: query name: f required: false schema: default: json enum: - json - html - jsonld - csv type: string style: form bbox: 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). explode: false in: query name: bbox required: false schema: items: type: number maxItems: 6 minItems: 4 type: array style: form bbox-crs: description: Indicates the coordinate reference system for the given bbox coordinates. explode: false in: query name: bbox-crs required: false schema: format: uri type: string style: form filter: 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')" in: query name: filter required: false schema: type: string crs: description: Indicates the coordinate reference system for the results. explode: false in: query name: crs required: false schema: format: uri type: string style: form wda_sortby: 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." explode: false in: query name: sortby required: false schema: items: pattern: '[+|-]?[A-Za-z_].*' type: string minItems: 1 type: array style: form lang: 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. in: query name: lang required: false schema: default: en-US enum: - en-US type: string responses: TooManyRequests429: content: application/json: examples: rateLimitExceeded: summary: Rate Limit Exceeded value: error: code: OVER_RATE_LIMIT message: You have exceeded your rate limit. Make sure you provided your API key from https://api.waterdata.usgs.gov/signup/, then either try again later or contact us at https://waterdata.usgs.gov/questions-comments/?referrerUrl=https://api.waterdata.usgs.gov for assistance. schema: $ref: '#/components/schemas/Error' application/xml: example: "<response>\n <error>\n <code>OVER_RATE_LIMIT</code>\n <message>You have exceeded your rate limit. Make sure you provided your API key from https://api.waterdata.usgs.gov/signup/, then either try again later or contact us at https://waterdata.usgs.gov/questions-comments/?referrerUrl=https://api.waterdata.usgs.gov for assistance.</message>\n </error>\n </response>" schema: properties: response: properties: error: properties: code: type: string message: type: string required: - code - message type: object required: - error type: object type: object text/csv: examples: rateLimitCsv: summary: Rate Limit Exceeded (CSV) value: 'Error Code,Error Message OVER_RATE_LIMIT,You have exceeded your rate limit. Make sure you provided your API key from https://api.waterdata.usgs.gov/signup/, then either try again later or contact us at https://waterdata.usgs.gov/questions-comments/?referrerUrl=https://api.waterdata.usgs.gov for assistance.' schema: type: string text/html: examples: rateLimitHtml: summary: Rate Limit Exceeded (HTML) value: "<html>\n <body>\n <h1>OVER_RATE_LIMIT</h1>\n <p>You have exceeded your rate limit. Make sure you provided your API key from https://api.waterdata.usgs.gov/signup/, then either try again later or contact us at https://waterdata.usgs.gov/questions-comments/?referrerUrl=https://api.waterdata.usgs.gov for assistance.</p>\n </body>\n </html>" schema: type: string description: Too Many Requests - Rate limit exceeded. Queryables: content: application/json: schema: $ref: '#/components/schemas/queryables' description: successful queryables operation Forbidden403: content: application/json: examples: missingApiKey: summary: Missing API Key value: error: code: API_KEY_MISSING message: No api_key was supplied. Get one at https://api.waterdata.usgs.gov/signup/ schema: $ref: '#/components/schemas/Error' application/xml: example: "<response>\n <error>\n <code>API_KEY_MISSING</code>\n <message>No api_key was supplied. Get one at https://api.waterdata.usgs.gov/signup/</message>\n </error>\n </response>" schema: properties: response: properties: error: properties: code: type: string message: type: string required: - code - message type: object required: - error type: object type: object text/csv: examples: missingApiKeyCsv: summary: Missing API Key (CSV) value: 'Error Code,Error Message API_KEY_MISSING, No api_key was supplied. Get one at https://api.waterdata.usgs.gov/signup/' schema: type: string text/html: examples: missingApiKeyHtml: summary: Missing API Key (HTML) value: "<html>\n <body>\n <h1>API_KEY_MISSING</h1>\n <p>No api_key was supplied. Get one at https://api.waterdata.usgs.gov/signup/</p>\n </body>\n </html>" schema: type: string description: Forbidden - API key is missing or not authorized for this resource. schemas: queryables: properties: queryables: items: $ref: '#/components/schemas/queryable' type: array required: - queryables type: object queryable: properties: description: description: a human-readable narrative describing the queryable type: string language: default: en description: the language used for the title and description type: string queryable: description: the token that may be used in a CQL predicate type: string title: description: a human readable title for the queryable type: string type: description: the data type of the queryable type: string type-ref: description: a reference to the formal definition of the type format: url type: string required: - queryable - type type: object Error: properties: error: properties: code: description: Error code such as OVER_RATE_LIMIT, see https://api.data.gov/docs/developer-manual/#general-web-service-errors type: string message: description: Error message type: string required: - code - message type: object type: object securitySchemes: ApiKeyHeader: description: Providing your API key gives you higher rate limits when querying our APIs. You can obtain an API key at https://api.waterdata.usgs.gov/signup in: header name: api_key type: apiKey ApiKeyQuery: description: Providing your API key gives you higher rate limits when querying our APIs. You can obtain an API key at https://api.waterdata.usgs.gov/signup in: query name: api_key type: apiKey