View water level data

get https://dashboard.hohonu.io/api/v1/stations/{stationId}/waterlevel

View water level data for a specific station.

NOTE - You may only request data within a 30 day range per call. Requesting data outside of this range will result in a 403.

Path Params

stationId

string

required

unique identifier of the station

Query Params

from

string

required

Start date of request data.

string

required

Stop date of request data.

units

string

enum

Defaults to english

The units of water level observations. english returns data in feet, while metric returns data in meters.

Allowed:

datum

string

enum

Defaults to D2W

The datum the data are referenced to.

Different datum options may be available for a station depending on the deployment type and installation history. If you pass a datum string that the station is not able to display, this will result in an error with the listed datums supported by that specific station.

D2W (Distance to Water)
Also known as the station datum. D2W measurements are simply how far away the water level is from the installed sensor. It is not an indication of the absolute height of the water, and should not be used as a way to compare to other locations.

NAVD (North American Vertical Datum of 1988)
A geodetic datum (such as NAVD88) is an abstract coordinate system with a reference surface (such as sea level) that serves to provide known locations to begin surveys and create maps.

MLLW (Mean Lower Low Water) / MHHW (Mean High High Water)
MLLW is the most common tidal datum, and reflects what you would see in a standard tide app.
MHHW is commonly used for monitoring storm surge and inundation.
Learn more about datums.

If tidal datums (MLLW, MHHW) are unavailable, the station may still be in the process of being deployed and configured.

FLOOD_DEPTH (Depth of Inundation)
Flood depth data are referenced to the surveyed NAVD88 station and ground heights, and measurements greater than 0 generally indicate the presence of inundation.

Only available for above ground deployments.

WATER_DEPTH (Water Depth)
Water depth data are referenced to the surveyed NAVD88 station and distance to the bottom.

Only available for water depth deployments.

Allowed:

qc_level

integer

enum

Defaults to 1

Quality level of processed data to return. Stations deployed over water and over land have different QC methods applied to them.
Learn more about our QC process. Only a single quality level is available for NOAA gages.

(0) Data with minimal post-processing, taken directly from sensor measurements. Due to sensor timestamping logic, duplicate samples may exists.
(1) Returns data with marginal levels of processing (i.e. Basic QC). 'No Target' data points and data points near the sensor are removed. Data points measured near the ground and below ground height (as applicable) are replaced with the boundary value. QC Level 1 data maintain the same timestamps as QC Level 0.
(2) These data are of the highest level of processing (i.e. Advanced QC), including filtering of spikes, high rates of change, flat lines, and high periods of volatility. QC Level 2 data are resampled to 1-min mean values.

Allowed:

flags

boolean

Defaults to false

Whether to show QC flags for each data point. Flags are only available for qc_level > 0 for Hohonu gages.
Flags are returned in the form of a comma separated string of integers, where each value represents individual QC test results.

Flag integers can take on the value of:

(1): PASS
(3): SUSPECT
(4): FAIL
(9): MISSING

The returned flag string differs for each qc_level. For more details on the specific QC tests mentioned below, please see here.

qc_level = 1
String: Z,X,X,X where Z is the rollup flag and X is an individual QC Flag value for the following tests:
- No Target Test
- Gross Range Test
- Boundary Test

qc_level = 2
String: Z,X,X,X,X,X where Z is the rollup flag and X is an individual QC Flag value for the following tests:
- Spike Test
- Rate of Change Test
- Flat Line Test
- Volatility Test
- Climatology Test

predictions

boolean

Defaults to false

Show Hohonu Tide Prediction values, as available, when set to true. Tidal predictions are currently available on a 6-min interval. Note that calling predictions with observations may return a higher interval dataset, producing gaps in the prediction time series.

observations

boolean

Defaults to true

Return a station's observations data, as available, when set to true

Responses

200Station water level.

400Error with request

404station id not found