River Gauge Parameters
Query parameters
Response parameters
The River Gauge API observation and station endpoints return JSON or GeoJSON responses, depending on query options.
River status response parameters (JSON format only)
Query parameters
| Parameter | Description | Default value | |
|---|---|---|---|
| api | Hostname for use in production applications: api.accuweather.com. | N/A | Required |
| apidev | Hostname for use in development applications: apidev.accuweather.com. | N/A | Required |
| version | The API version (currently v1). | v1 | Required |
| countrycode | A code that identifies the country where observations should be queried. | N/A | Optional |
| admincode | A code that identifies the area within the country where observations should be queried. | N/A | Optional |
| apikey | A unique code to access AccuWeather's APIs. | N/A | Required |
| upperleft | The northwestern most corner of a bounding box that defines the search area. Query using the format latitude,longitude. |
N/A | Optional |
| lowerright | The southeastern most corner of a bounding box that defines the search area. Query using the format latitude,longitude. |
N/A | Optional |
| metric | A Boolean value that specifies whether to return the data in metric units (true) or imperial units (false). | false | Optional |
| format | A string that indicates the response format. Options are json or geojson. |
json | Optional |
| includeUnits | A Boolean value that specifies whether to return values, units, and unit types (true) or only values (false) for each measurement. | false | Optional |
Response parameters
The River Gauge API observation and station endpoints return JSON or GeoJSON responses, depending on query options.
Observation response, JSON format
| Parameter | Description | ||
|---|---|---|---|
| observation | An object containing date and time at which the data was recorded, as well as the recorded value. | ||
| dateTime | The data records' date and time in ISO 8601 format (yyyy-mm-ddThh:mm:ss+hh:mm). |
||
| height | When includeUnits=true, an object that contains information about the current river depth measurement. When includeUnits=false, the current river depth measurement in the requested units. |
||
| value | The current river depth measurement in the requested units. Only returned when includeUnits=true. |
||
| unit | The river height unit of measure. Only returned when includeUnits=true. |
||
| categories | An object containing various sub-sections that describe the river's current state. Will return null when all sub-sections are null. |
||
| action | When includeUnits=true, an object that contains information about the NOAA action threshold measurement. When includeUnits=false, the NOAA action threshold measurement in the requested units. Can return null. |
||
| value | The action threshold measurement in the requested units. Only returned when includeUnits=true. |
||
| unit | The action threshold unit of measure. Only returned when includeUnits=true. |
||
| flood | When includeUnits=true, an object that contains information about the minor flood threshold measurement. When includeUnits=false, the flood threshold measurement in the requested units. Can return null. |
||
| value | The minor flood threshold measurement in the requested units. Only returned when includeUnits=true. |
||
| unit | The minor flood threshold unit of measure. Only returned when includeUnits=true. |
||
| moderate | When includeUnits=true, an object that contains information about the measurement at which the flood stage increases to moderate. When includeUnits=false, the measurement at which the flood stage increases to moderate in the requested units. Can return null. |
||
| value | The moderate flood threshold measurement in the requested units. Only returned when includeUnits=true. |
||
| unit | The moderate flood threshold unit of measure. Only returned when includeUnits=true. |
||
| major | When includeUnits=true, an object that contains information about the measurement at which the flood stage increases to major. When includeUnits=false, the measurement at which the flood stage increases to major in the requested units. Can return null. |
||
| value | The major flood threshold measurement in the requested units. Only returned when includeUnits=true. |
||
| unit | The major flood threshold unit of measure. Only returned when includeUnits=true. |
||
| lowThreshold | When includeUnits=true, an object that contains information about the measurement at which the water body is considered to be low. When includeUnits=false, the measurement at which the water body is considered to be low in the requested units. Can return null. |
||
| value | The low water threshold measurement in the requested units. Only returned when includeUnits=true. |
||
| unit | The low water threshold unit of measure. Only returned when includeUnits=true. |
||
| id | A unique alphanumeric code that identifies the observation station. | ||
| location | An object that contains information about the observation geography. | ||
| name | A string that indicates the observation location. | ||
| countryCode | A unique character string that identifies the country in which the observation was recorded. | ||
| adminCode | A unique character string that identifies the area within the country in which the observation was recorded. | ||
| waterBody | The name of the measured water body. | ||
| status | An object containing information about the water body's current state. See the status chart for statuses and corresponding colors. | ||
| id | A string that indicates the water body's current state. | ||
| name | A brief description of the water body's current state. | ||
| colorHex | The six-digit additive color definition value for a color that indicates the water body's current state, returned as a string. | ||
Observation response, GeoJSON format
| Parameter | Description | ||||
|---|---|---|---|---|---|
| type | A string describing the object that follows in the response. | ||||
| features | An object containing the full data collection for all requested observation stations. | ||||
| type | A string describing the object that follows in the response. | ||||
| geometry | An object containing geographic data that describes the observation location. | ||||
| coordinates | The geographic coordinates of the observation location returned as [longitude, latitude]. | ||||
| type | The geometry type. | ||||
| properties | An object containing river observation data collected at the described location. | ||||
| observation | An object containing date and time at which the data was recorded, as well as the recorded value. | ||||
| dateTime | The data records' date and time in ISO 8601 format (yyyy-mm-ddThh:mm:ss+hh:mm). |
||||
| height | When includeUnits=true, an object that contains information about the current river depth measurement. When includeUnits=false, the current river depth measurement in the requested units. |
||||
| value | The current river depth measurement in the requested units. Only returned when includeUnits=true. |
||||
| unit | The river height unit of measure. Only returned when includeUnits=true. |
||||
| categories | An object containing various sub-sections that describe the river's current state. Will return null when all sub-sections are null. |
||||
| action | When includeUnits=true, an object that contains information about the NOAA action threshold measurement. When includeUnits=false, the NOAA action threshold measurement in the requested units. Can return null. |
||||
| value | The action threshold measurement in the requested units. Only returned when includeUnits=true. |
||||
| unit | The action threshold unit of measure. Only returned when includeUnits=true. |
||||
| flood | When includeUnits=true, an object that contains information about the minor flood threshold measurement. When includeUnits=false, the flood threshold measurement in the requested units. Can return null. |
||||
| value | The minor flood threshold measurement in the requested units. Only returned when includeUnits=true. |
||||
| unit | The minor flood threshold unit of measure. Only returned when includeUnits=true. |
||||
| moderate | When includeUnits=true, an object that contains information about the measurement at which the flood stage increases to moderate. When includeUnits=false, the measurement at which the flood stage increases to moderate in the requested units. Can return null. |
||||
| value | The moderate flood threshold measurement in the requested units. Only returned when includeUnits=true. |
||||
| unit | The moderate flood threshold unit of measure. Only returned when includeUnits=true. |
||||
| major | When includeUnits=true, an object that contains information about the measurement at which the flood stage increases to major. When includeUnits=false, the measurement at which the flood stage increases to major in the requested units. Can return null. |
||||
| value | The major flood threshold measurement in the requested units. Only returned when includeUnits=true. |
||||
| unit | The major flood threshold unit of measure. Only returned when includeUnits=true. |
||||
| lowThreshold | When includeUnits=true, an object that contains information about the measurement at which the water body is considered to be low. When includeUnits=false, the measurement at which the water body is considered to be low in the requested units. Can return null. |
||||
| value | The low water threshold measurement in the requested units. Only returned when includeUnits=true. |
||||
| unit | The low water threshold unit of measure. Only returned when includeUnits=true. |
||||
| id | A unique alphanumeric code that identifies the observation station. | ||||
| location | An object that contains information about the observation geography. | ||||
| name | A string that indicates the observation location. | ||||
| countryCode | A unique character string that identifies the country in which the observation was recorded. | ||||
| adminCode | A unique character string that identifies the area within the country in which the observation was recorded. | ||||
| waterBody | The name of the measured water body. | ||||
| status | An object containing information about the water body's current state. See the status chart for statuses and corresponding colors. | ||||
| id | A string that indicates the water body's current state. | ||||
| name | A brief description of the water body's current state. | ||||
| colorHex | The six-digit additive color definition value for a color that indicates the water body's current state, returned as a string. | ||||
Station response, JSON format
| Parameter | Description | |
|---|---|---|
| id | A unique alphanumeric code that identifies the observation station. | |
| goesId | The geostationary satellite ID number. | |
| dcpOwner | The data collection platform owner's identification. | |
| hydrologicServiceArea | The hydrologic service area identification. | |
| location | An object containing information about the geographical area where the observation station is located. | |
| name | The name of the town located nearest to the observation station's location. | |
| countryCode | A unique character string that identifies the country in which the observation station is located. | |
| adminCode | A unique character string that identifies the area within the country in which the observation station is located. | |
Station response, GeoJSON format
| Parameter | Description | |||
|---|---|---|---|---|
| type | A string describing the object that follows in the response. | |||
| features | An object containing the full data collection for all requested observation stations. | |||
| type | A string describing the object that follows in the response. | |||
| geometry | An object containing geographic data that describes the observation station's location. | |||
| coordinates | The geographic coordinates of the observation station's location returned as [longitude, latitude]. | |||
| type | The geometry type. | |||
| properties | An object containing observation station data. | |||
| id | A unique alphanumeric code that identifies the observation station. | |||
| goesId | The geostationary satellite ID number. | |||
| dcpOwner | The data collection platform owner's identification. | |||
| hydrologicServiceArea | The hydrologic service area identification. | |||
| location | An object containing information about the geographical area where the observation station is located. | |||
| name | The name of the town located nearest to the observation station's location. | |||
| countryCode | A unique character string that identifies the country in which the observation station is located. | |||
| adminCode | A unique character string that identifies the area within the country in which the observation station is located. | |||
River status (JSON format only)
| Parameter | Description | |
|---|---|---|
| id | A string that indicates the river's status level. See the status chart for possible values. | |
| name | A brief description of the water body's current state. | |
| colorHex | The six-digit additive color definition value for a color that indicates the water body's current state, returned as a string. See the status chart for statuses and corresponding colors. | |