changedInput schema / properties / datum / description
Previous value: -"Tidal datum reference plane. MLLW (default) is the US nautical chart datum. MSL = mean sea level; MHHW = mean higher high water (flooding reference)."New value: +"Datum the observed heights are referenced to. MLLW (default) is the US nautical chart datum, and MHHW (mean higher high water) is the flooding reference; MHW, MTL, MSL, and MLW are the other tidal planes. NAVD is NAVD88 and reads only where the station has an NAVD88 tie. STND is the station's own datum and is the plane that works where no tidal datum exists. IGLD and LWD apply at Great Lakes stations only, CRD at Columbia River stations only, and LWI and HWI are lunitidal intervals rather than heights. A datum this station does not carry comes back as datum_unavailable naming the ones it does."
changedInput schema / properties / datum / enum
Previous value: -[
- "MLLW",
- "MHHW",
- "MSL",
- "MTL",
- "MHW",
- "MLW",
- "CD",
- "STND"
-]New value: +[
+ "MLLW",
+ "MHHW",
+ "MHW",
+ "MTL",
+ "MSL",
+ "MLW",
+ "NAVD",
+ "STND",
+ "IGLD",
+ "LWD",
+ "CRD",
+ "LWI",
+ "HWI"
+]
addedInput schema / properties / interval
Added value: +{
+ "default": "6min",
+ "description": "Observed cadence. 6min (default) is the full curve, 31 days per request, the only one carrying a quality flag. hourly is hourly heights, 365 days per request, and reports a residual against the hourly prediction series. high_low is the observed high and low waters with their H/HH/L/LL classification, 365 days per request, and reports no residual because observed extremes do not fall on predicted extreme times. daily_mean is the daily mean water level, 3655 days per request, published at Great Lakes stations only and with no paired prediction series; a coastal station comes back as great_lakes_only.",
+ "enum": [
+ "6min",
+ "hourly",
+ "high_low",
+ "daily_mean"
+ ],
+ "type": "string"
+}
addedInput schema / properties / limit
Added value: +{
+ "description": "Maximum observation rows to return on this page, for a caller that wants fewer than the response budget allows. Omit for the largest page that fits; a value larger than the budget allows does not widen the page.",
+ "maximum": 9007199254740991,
+ "minimum": 1,
+ "type": "integer"
+}
addedInput schema / properties / offset
Added value: +{
+ "default": 0,
+ "description": "Row offset into the matched observation series, for reading a range whose rows do not fit one response. 0 (default) starts at the first row; pass the next_offset from a previous call to continue. An offset past the last row returns an empty page rather than an error.",
+ "maximum": 9007199254740991,
+ "minimum": 0,
+ "type": "integer"
+}
changedInput schema / properties / time_zone / description
Previous value: -"Time zone for returned timestamps. lst_ldt = local standard/daylight time (default); gmt = UTC; lst = local standard time year-round."New value: +"Time zone for returned timestamps. lst_ldt = local standard/daylight time (default); gmt = UTC; lst = local standard time year-round. Overridden to lst on interval=\"daily_mean\", which CO-OPS serves in local standard time only and otherwise stamps every row a day off."
changedOutput schema / anyOf
Previous value: -[
- {
- "not": {
- "required": [
- "error"
- ]
- },
- "required": [
- "station_id",
- "station_name",
- "datum",
- "units",
- "observations",
- "predictions"
- ]
- },
- {
- "required": [
- "error"
- ]
- }
-]New value: +[
+ {
+ "not": {
+ "required": [
+ "error"
+ ]
+ },
+ "required": [
+ "station_id",
+ "station_name",
+ "datum",
+ "units",
+ "interval",
+ "observations",
+ "predictions"
+ ]
+ },
+ {
+ "required": [
+ "error"
+ ]
+ }
+]
changedOutput schema / properties / error / properties / data / properties / reason / description
Previous value: -"Machine-readable failure mode. Declared by this tool: `station_not_found`: CO-OPS returned an error for the station ID. `invalid_date_range`: begin_date/end_date is not a real calendar date or begin_date is after end_date `date_range_exceeded`: Requested date range exceeds the 31-day CO-OPS limit for 6-minute water level data. `no_data`: Station exists but no observed water-level data for the date range. Other values are possible when a failure originates below the handler."New value: +"Machine-readable failure mode. Declared by this tool: `station_not_found`: CO-OPS returned an error for the station ID. `invalid_date_range`: begin_date/end_date is not a real calendar date or begin_date is after end_date `date_range_exceeded`: Requested date range exceeds the selected interval's CO-OPS limit — 31 days for 6min, 365 for hourly and high_low, 3655 for daily_mean. `no_data`: Station exists but no observed water-level data for the date range. `great_lakes_only`: interval=\"daily_mean\" was requested for a coastal station — CO-OPS publishes water-level daily means at Great Lakes stations only. `verified_data_lag`: The hourly, high_low, or daily_mean product returned no rows for the window, which CO-OPS has not published yet. `datum_unavailable`: The station does not carry the requested datum — a Great Lakes station has no tidal datum, and NAVD reads only where the station has an NAVD88 tie. Other values are possible when a failure originates below the handler."
changedOutput schema / properties / error / properties / data / properties / reason / examples
Previous value: -[
- "station_not_found",
- "invalid_date_range",
- "date_range_exceeded",
- "no_data"
-]New value: +[
+ "station_not_found",
+ "invalid_date_range",
+ "date_range_exceeded",
+ "no_data",
+ "great_lakes_only",
+ "verified_data_lag",
+ "datum_unavailable"
+]
addedOutput schema / properties / gaps_dropped
Added value: +{
+ "description": "Number of sample slots CO-OPS sent with no reading, dropped from observations. Present only when there was at least one. The observed series is therefore not continuous across the requested range: it has this many missing slots, and rows_matched counts only the slots that carry a value.",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+}
addedOutput schema / properties / interval
Added value: +{
+ "description": "Observed cadence echoed from the request — the CO-OPS product these rows came from, and what decides whether quality, type, and residual_summary are populated.",
+ "enum": [
+ "6min",
+ "hourly",
+ "high_low",
+ "daily_mean"
+ ],
+ "type": "string"
+}
addedOutput schema / properties / next_offset
Added value: +{
+ "anyOf": [
+ {
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Offset to pass as offset on the next call, or null when this page reaches the last matched observation. Absent when the whole matched series was returned."
+}
changedOutput schema / properties / notice / description
Previous value: -"Why the paired prediction series is missing, when it is missing."New value: +"Why the paired prediction series is missing or carries no residual, how many sample slots were dropped, and what this page of the observed series covers — whichever of those apply, composed into one string."
changedOutput schema / properties / observations / description
Previous value: -"6-minute observed water level readings."New value: +"Observed water level readings at the requested cadence — the whole matched series when it fits one response, otherwise the leading page starting at offset. rows_matched and next_offset report what a page left behind."
changedOutput schema / properties / observations / items / description
Previous value: -"A single 6-minute observed water level reading."New value: +"A single observed water level reading at the requested cadence."
changedOutput schema / properties / observations / items / properties / quality / description
Previous value: -"Quality flag: p = preliminary, v = verified."New value: +"Quality flag: p = preliminary, v = verified. Present on the 6min interval only — CO-OPS sends no flag with the hourly, high_low, or daily_mean products, which are verified data, so the field is absent rather than defaulted to preliminary."
changedOutput schema / properties / observations / items / properties / sigma / description
Previous value: -"Standard deviation of the water level sensor reading."New value: +"Standard deviation of the water level sensor reading. Present on the 6min and hourly intervals; CO-OPS sends none for high_low or daily_mean."
addedOutput schema / properties / observations / items / properties / type
Added value: +{
+ "description": "Observed extreme classification on the high_low interval: H = high water, HH = higher high water, L = low water, LL = lower low water. Absent on every other interval.",
+ "enum": [
+ "H",
+ "HH",
+ "L",
+ "LL"
+ ],
+ "type": "string"
+}
changedOutput schema / properties / observations / items / required
Previous value: -[
- "time",
- "value",
- "quality"
-]New value: +[
+ "time",
+ "value"
+]
addedOutput schema / properties / page_offset
Added value: +{
+ "description": "Observation row offset this page starts at, echoed from the request. Absent when the whole matched series was returned.",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+}
changedOutput schema / properties / predictions / description
Previous value: -"Paired 6-minute tide predictions for the same period. Empty when CO-OPS returned no predictions for this station and range, or when the prediction fetch failed — predictions_status says which."New value: +"Paired tide predictions covering the same period as the returned observations, at the interval matching the observed cadence. Always empty on the daily_mean interval, which has no paired series. Otherwise empty when CO-OPS returned no predictions for this station and range, or when the prediction fetch failed — predictions_status says which."
changedOutput schema / properties / predictions / items / description
Previous value: -"A single 6-minute tide prediction."New value: +"A single tide prediction."
changedOutput schema / properties / predictions / items / properties / time / description
Previous value: -"Prediction datetime matching the observation time step."New value: +"Prediction datetime in the requested time zone."
changedOutput schema / properties / predictions_status / description
Previous value: -"Present only when predictions is empty. \"empty\" means CO-OPS returned no prediction rows for this station and date range; \"unavailable\" means the prediction fetch failed, so no comparison series could be retrieved and the absence says nothing about the station. Absent when predictions were returned."New value: +"Present only when predictions is empty on an interval that has a paired series. \"empty\" means CO-OPS returned no prediction rows for this station and date range; \"unavailable\" means the prediction fetch failed, so no comparison series could be retrieved and the absence says nothing about the station. Absent when predictions were returned, and on the daily_mean interval, which has no paired series to report on."
changedOutput schema / properties / residual_summary / description
Previous value: -"Summary of observed-minus-predicted residuals in the requested units. Only present when both observations and predictions are available."New value: +"Summary of observed-minus-predicted residuals in the requested units, computed across the whole matched series rather than the returned page — so a paged response still reports the largest surge in the range. Present only on the 6min and hourly intervals, and only when both series are available; the notice says why it is absent on high_low and daily_mean."
addedOutput schema / properties / rows_matched
Added value: +{
+ "description": "Observation rows the requested date range matched, before the page was cut. Absent when the whole matched series was returned.",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+}
addedOutput schema / properties / rows_returned
Added value: +{
+ "description": "Observation rows this page carries — the length of observations. Absent when the whole matched series was returned.",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+}
addedOutput schema / properties / truncated
Added value: +{
+ "description": "True when this page stops short of the last matched observation, so further rows remain at next_offset. False on the final page and on a page past the end. Absent when the whole matched series was returned.",
+ "type": "boolean"
+}