# Parameters

## Request parameters

| Parameter | Description | Default | Required |
| --- | --- | --- | --- |
| `version` | The API version (currently v1). | v1 | Yes |
| `countrycode` | A code that identifies the country where observations should be queried. | — | No |
| `admincode` | A code that identifies the area within the country where observations should be queried. | — | No |
| `apikey` | A unique code to access AccuWeather's APIs. | — | Yes |
| `upperleft` | The northwestern most corner of a bounding box that defines the search area. Query using the format `latitude,longitude`. | — | No |
| `lowerright` | The southeastern most corner of a bounding box that defines the search area. Query using the format `latitude,longitude`. | — | No |
| `metric` | A Boolean value that specifies whether to return the data in metric units (true) or imperial units (false). | false | No |
| `format` | A string that indicates the response format. Options are `json` or `geojson`. | json | No |
| `includeUnits` | A Boolean value that specifies whether to return values, units, and unit types (true) or only values (false) for each measurement. | false | No |

---

## Response parameters

The River Gauge API observation and station endpoints return JSON or GeoJSON responses, depending on query options.

### Observation response, JSON Format

| Field | Type | Description |
| --- | --- | --- |
| `observation` | object | An object containing date and time at which the data was recorded, as well as the recorded value. |
| `observation.dateTime` | string | The data records' date and time in ISO 8601 format (`yyyy-mm-ddThh:mm:ss+hh:mm`). |
| `observation.height` | object | 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. |
| `observation.height.value` | number | The current river depth measurement in the requested units. Only returned when `includeUnits=true`. |
| `observation.height.unit` | string | The river height unit of measure. Only returned when `includeUnits=true`. |
| `categories` | object | An object containing various sub-sections that describe the river's current state. Will return `null` when all sub-sections are `null`. |
| `categories.action` | object | 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`. |
| `categories.action.value` | number | The action threshold measurement in the requested units. Only returned when `includeUnits=true`. |
| `categories.action.unit` | string | The action threshold unit of measure. Only returned when `includeUnits=true`. |
| `categories.flood` | object | 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`. |
| `categories.flood.value` | number | The minor flood threshold measurement in the requested units. Only returned when `includeUnits=true`. |
| `categories.flood.unit` | string | The minor flood threshold unit of measure. Only returned when `includeUnits=true`. |
| `categories.moderate` | object | 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`. |
| `categories.moderate.value` | number | The moderate flood threshold measurement in the requested units. Only returned when `includeUnits=true`. |
| `categories.moderate.unit` | string | The moderate flood threshold unit of measure. Only returned when `includeUnits=true`. |
| `categories.major` | object | 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`. |
| `categories.major.value` | number | The major flood threshold measurement in the requested units. Only returned when `includeUnits=true`. |
| `categories.major.unit` | string | The major flood threshold unit of measure. Only returned when `includeUnits=true`. |
| `categories.lowThreshold` | object | 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`. |
| `categories.lowThreshold.value` | number | The low water threshold measurement in the requested units. Only returned when `includeUnits=true`. |
| `categories.lowThreshold.unit` | string | The low water threshold unit of measure. Only returned when `includeUnits=true`. |
| `id` | string | A unique alphanumeric code that identifies the observation station. |
| `location` | object | An object that contains information about the observation geography. |
| `location.name` | string | A string that indicates the observation location. |
| `location.countryCode` | string | A unique character string that identifies the country in which the observation was recorded. |
| `location.adminCode` | string | A unique character string that identifies the area within the country in which the observation was recorded. |
| `waterBody` | string | The name of the measured water body. |
| `status` | object | An object containing information about the water body's current state. See the [status chart](river-gauge#status) for statuses and corresponding colors. |
| `status.id` | string | A string that indicates the water body's current state. |
| `status.name` | string | A brief description of the water body's current state. |
| `status.colorHex` | string | 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

| Field | Type | Description |
| --- | --- | --- |
| `type` | string | A string describing the object that follows in the response. |
| `features[]` | array | An object containing the full data collection for all requested observation stations. |
| `features[].type` | string | A string describing the object that follows in the response. |
| `features[].geometry` | object | An object containing geographic data that describes the observation location. |
| `features[].geometry.coordinates` | array | The geographic coordinates of the observation location returned as [longitude, latitude]. |
| `features[].geometry.type` | string | The geometry type. |
| `features[].properties` | object | An object containing river observation data collected at the described location. |
| `features[].properties.observation` | object | An object containing date and time at which the data was recorded, as well as the recorded value. |
| `features[].properties.observation.dateTime` | string | The data records' date and time in ISO 8601 format (`yyyy-mm-ddThh:mm:ss+hh:mm`). |
| `features[].properties.observation.height` | object | 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. |
| `features[].properties.observation.height.value` | number | The current river depth measurement in the requested units. Only returned when `includeUnits=true`. |
| `features[].properties.observation.height.unit` | string | The river height unit of measure. Only returned when `includeUnits=true`. |
| `features[].properties.categories` | object | An object containing various sub-sections that describe the river's current state. Will return `null` when all sub-sections are `null`. |
| `features[].properties.categories.action` | object | 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`. |
| `features[].properties.categories.action.value` | number | The action threshold measurement in the requested units. Only returned when `includeUnits=true`. |
| `features[].properties.categories.action.unit` | string | The action threshold unit of measure. Only returned when `includeUnits=true`. |
| `features[].properties.categories.flood` | object | 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`. |
| `features[].properties.categories.flood.value` | number | The minor flood threshold measurement in the requested units. Only returned when `includeUnits=true`. |
| `features[].properties.categories.flood.unit` | string | The minor flood threshold unit of measure. Only returned when `includeUnits=true`. |
| `features[].properties.categories.moderate` | object | 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`. |
| `features[].properties.categories.moderate.value` | number | The moderate flood threshold measurement in the requested units. Only returned when `includeUnits=true`. |
| `features[].properties.categories.moderate.unit` | string | The moderate flood threshold unit of measure. Only returned when `includeUnits=true`. |
| `features[].properties.categories.major` | object | 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`. |
| `features[].properties.categories.major.value` | number | The major flood threshold measurement in the requested units. Only returned when `includeUnits=true`. |
| `features[].properties.categories.major.unit` | string | The major flood threshold unit of measure. Only returned when `includeUnits=true`. |
| `features[].properties.categories.lowThreshold` | object | 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`. |
| `features[].properties.categories.lowThreshold.value` | number | The low water threshold measurement in the requested units. Only returned when `includeUnits=true`. |
| `features[].properties.categories.lowThreshold.unit` | string | The low water threshold unit of measure. Only returned when `includeUnits=true`. |
| `features[].properties.id` | string | A unique alphanumeric code that identifies the observation station. |
| `features[].properties.location` | object | An object that contains information about the observation geography. |
| `features[].properties.location.name` | string | A string that indicates the observation location. |
| `features[].properties.location.countryCode` | string | A unique character string that identifies the country in which the observation was recorded. |
| `features[].properties.location.adminCode` | string | A unique character string that identifies the area within the country in which the observation was recorded. |
| `features[].properties.waterBody` | string | The name of the measured water body. |
| `features[].properties.status` | object | An object containing information about the water body's current state. See the [status chart](river-gauge#status) for statuses and corresponding colors. |
| `features[].properties.status.id` | string | A string that indicates the water body's current state. |
| `features[].properties.status.name` | string | A brief description of the water body's current state. |
| `features[].properties.status.colorHex` | string | 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

| Field | Type | Description |
| --- | --- | --- |
| `id` | string | A unique alphanumeric code that identifies the observation station. |
| `goesId` | string | The geostationary satellite ID number. |
| `dcpOwner` | string | The data collection platform owner's identification. |
| `hydrologicServiceArea` | string | The hydrologic service area identification. |
| `location` | object | An object containing information about the geographical area where the observation station is located. |
| `location.name` | string | The name of the town located nearest to the observation station's location. |
| `location.countryCode` | string | A unique character string that identifies the country in which the observation station is located. |
| `location.adminCode` | string | A unique character string that identifies the area within the country in which the observation station is located. |

---

### Station response, GeoJSON format

| Field | Type | Description |
| --- | --- | --- |
| `type` | string | A string describing the object that follows in the response. |
| `features[]` | array | An object containing the full data collection for all requested observation stations. |
| `features[].type` | string | A string describing the object that follows in the response. |
| `features[].geometry` | object | An object containing geographic data that describes the observation station's location. |
| `features[].geometry.coordinates` | array | The geographic coordinates of the observation station's location returned as [longitude, latitude]. |
| `features[].geometry.type` | string | The geometry type. |
| `features[].properties` | object | An object containing observation station data. |
| `features[].properties.id` | string | A unique alphanumeric code that identifies the observation station. |
| `features[].properties.goesId` | string | The geostationary satellite ID number. |
| `features[].properties.dcpOwner` | string | The data collection platform owner's identification. |
| `features[].properties.hydrologicServiceArea` | string | The hydrologic service area identification. |
| `features[].properties.location` | object | An object containing information about the geographical area where the observation station is located. |
| `features[].properties.location.name` | string | The name of the town located nearest to the observation station's location. |
| `features[].properties.location.countryCode` | string | A unique character string that identifies the country in which the observation station is located. |
| `features[].properties.location.adminCode` | string | A unique character string that identifies the area within the country in which the observation station is located. |

---

### River status (JSON format only)

| Field | Type | Description |
| --- | --- | --- |
| `id` | string | A string that indicates the river's status level. See the [status chart](river-gauge#status) for possible values. |
| `name` | string | A brief description of the water body's current state. |
| `colorHex` | string | 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](river-gauge#status) for statuses and corresponding colors. |