Endpoint: rivers/gauges

The rivers/gauges endpoint provides access to enhanced information for the river and lake gauges utilized within the rivers endpoint. The primary source the gauge information is the NOAA Advanced Hydrologic Prediction Service (AHPS). Gauge information will include location information and when available recent crests, historical crests and flood impacts.

Supported Actions

The following actions are supported with the rivers/gauges endpoint:

:id

Requesting data by using the :id action is used for returning data for a particular item that has an ID associated with it. This is the primary method for requesting general weather information for a single location (observations, forecasts, advisories, etc.) as the location's name or a zip code serves as the id. Other endpoints may expect a certain value for the ID, such as storm cells whose ID value is a combination of the radar site identifier and unique identifier assigned to every storm cell. Refer to an enpoint's detailed documentation for specific information regarding how to use the :id action.

closest

The closest action will query the API for data that is closest to the requested place and return the results, if any, in order from closest to farthest. If no limit is provided in the request, then only the closest single result will be returned.

If your request does not return results, you may try setting or increasing the radius being used.

search

The search action is used as a more general query method and expects the query to be defined with the custom query for the request. Unlike the closest action, results will not be returned in any particular order.

within

The within action allows for returning data within a variety of different geometrical regions. Currently supported geometries include a circle (requires a center point and radius), square (requires two coordinate points defining the top-left and bottom-right corners) and polygon (requires at least three coordinate points). Unlike the closest action, the results will not be returned in any particular order based on distance.

Supported Parameters

The following parameters are optional unless otherwise noted:

p

p=:place

Defines the location to query data for. Refer to the list of supported place value formats.

limit

limit=:total

The total number of results to return as an integer. Each endpoint may have a set maximum for this value depending on usage.

The default limit is 1 if not specified.

skip

skip=:number

Used to skip over a specific number of results in the data set.

query

query=:string

Used to filter results based on certain fields in the data set. See Advanced Queries for more details.

filter

filter=:string

Predefined filters for limiting the results. The filter value can be a single, comma-delimited or a semicolon delimited string of filter names.

sort

sort=:string

Used to sort results based on certain fields in the data set. See Sorting for more details.

radius

radius=:distance:unit

When requesting the closest results within a circle, the radius determines how far from the specified location to search. A valid unit value must be included in your radius value, e.g., "5mi", "10km", "25miles". If no unit is provided, your value is assumed to be in meters by default.

Most endpoints utilize a default radius of 50 miles, though some endpoints, such as lightning, may have tighter restrictions specified.

callback

callback=:functionName

Used with JSONP implementation.

Defines the callback function to use for the response. The response will be enclosed as C(response), where C is the callback function provided.

fields

fields=:string

Provides a comma separated list of values for the API to return. This parameter is often used to limit the amount of data returned. See Reducing Output.

format

format=:string

Defines the API output format. The available options include:format=json - Standard JSON output. This is the default.format=geojson - API will output GeoJSON

Supported Filters

The following filters can be passed to the filter parameter to reduce the results that are returned:

impacts

Limit results to gauges with flood impact information

recentcrests

Limit results to gauges that have recent crest information

historiccrests

Limit results to gauges that have historic crest information

lowwaterrecords

Limit results to gauges that have low water record information

Supported Query Properties

Use the following supported property keys when creating custom queries for your requests:

id

Query by the gauge ID

place

Query by the gauge place name

waterbody

Query by the gauge waterbody name

state

Query by the gauge two letter state abbreviation

country

Query by the gauge two letter country abbreviation

Sortable Fields

You can use the following fields to sort the data returned in your response:

id

Sort by the gauge IDs

place

Sort by the gauge place names

waterbody

Sort by the gauge waterbodys

state

Sort by the gauge two letter state abbreviation

country

Sort by the gauge two letter country abbreviation

Examples

The /[:endpoint]/[:action]? portion within the query template below can be exchanged with any of the examples. Also, please note you will need to input your client credentials in the [ID] and [SECRET] fields which can be found under the Apps section of the members area.