The CO-OPS Derived Product API (DPAPI) can be used to retrieve
information about CO-OPS' derived products. The types of product
accessible via the API are listed in detail under the heading "
Products".
Version 0.1 - Initial Development Release
Version 0.1 is the draft development release of the CO-OPS Derived
Product API. As changes are made to the API and fields are added
or modified, the release notes contained within this section will
be updated to reflect the changes.
Version 0.1:
- Documentation created
- Product Types
- Top Ten Water Levels
- Extreme Water Levels
- Sea Level Trends
- High Tide Flooding Data
- Daily Flood Count
- Monthly Flood Count
- Seasonal Flood Count
- Annual Flood Count
- Met Year Flood Count
- Next Met Year Annual Outlook
- Projected Floods Per Year Per Scenario
- Decadal Projections
- Output formats
Top Ten Water Levels
- Input Parameters
- name: toptenwaterlevels
- station: 7-digit station ID (if omitted, all stations
are returned)
- units: Output units (english/metric, if omitted,
english units are used)
- datum: Datum reference
(STND/MHHW/MHW/MSL/MTL/MLW/MLLW/NAVD for Tidal stations and
IGLD/LWD for Great Lakes stations, not case-sensitive, if
omitted, MHHW/IGLD is used)
- Output
- Station ID
- Station Name
- Date
- Time
- Water Level Height
- Reference Datum
- Event Category (e.g. tropical, extratropical, etc).
- Event Name
- Data Source (e.g. observed, high water mark, etc)
Event Station Peak Water Levels
- Input Parameters
- name: peakwaterlevels
- event id: Numerical identifier corresponding to a peak
water level event (see Peak Water Level Events)
- units: Output units (english/metric, if omitted,
english units are used)
- datum: Datum reference
(STND/MHHW/MHW/MSL/MTL/MLW/MLLW/NAVD for Tidal stations and
IGLD/LWD for Great Lakes stations, not case-sensitive, if
omitted, MHHW/IGLD is used)
- Output
- Station ID
- Station Name
- Date
- Water Level Height
- Reference Datum
- Event Category (e.g. tropical, extratropical, etc).
- Event Name
- Data Source (e.g. observed, high water mark, etc)
Peak Water Level Events
- Input Parameters
- name: peakwaterlevels
- year: 4-digit year
- Output
- Event ID
- Start Date (estimated date when water level impacts
began)
- Name
- Event Type (e.g. Tropical, Extra Tropical, Other)
- Dissemination flag (Used for web products)
- Great Lake flag (Used for web products)
- Storm Track flag (Used for web products)
Extreme Water Levels
- Input Parameters
- name: extremewaterlevels
- station: 7-digit station ID (if omitted, all stations
are returned)
- units: Output units (english/metric, if omitted,
english units are used)
- Output
- Station ID
- Station Name
- State
- Latitude
- Longitude
- f1_gtmhhw (1% exceedance probability: above MHHW)
- f1_ltmllw (1% exceedance probability: below MLLW)
- f10_gtmhhw (10% exceedance probability: above MHHW)
- f10_ltmllw (10% exceedance probability: below MLLW)
- f50_gtmhhw (50% exceedance probability: above MHHW)
- f50_ltmllw (50% exceedance probability: below MLLW)
- f99_gtmhhw (99% exceedance probability: above MHHW)
- f99_ltmllw (99% exceedance probability: below MLLW)
Regional Frequency Analysis
(RFA) Extreme Water Levels (EWL)
RFA-based EWL probabilities and their 95% confidence
intervals are from the Global and Regional Sea Level Rise
Scenarios for the United States: Updated Mean Projections and
Extreme Water Level Probabilities Along U.S. Coastlines (2022
Interagency Task Force (ITF)) and Downscaling gridded extreme
water level estimates at short term tide gauge locations (2025)
reports.
- Input Parameters
- station: 7-digit NOS station ID (if omitted, all
stations are returned)
- units: Output units (english/metric; if omitted,
english is used)
- datum: Tidal datum reference for returned data (STND,
MLLW, MHHW, MSL, MLW, MHW; default is MHHW)
- Output Parameters
- stationId: NOS station 7-digit ID
- tidalEpoch: Tidal datum epoch used for analysis
- gridNum: Index of 1° EWL grid cell used for
downscaling
- gridLat: Latitude of EWL grid cell center
- gridLong: Longitude of EWL grid cell center
- region: Geographic region from the ITF Report
- localUIndex: Local U-index (unit: meters/feet)
- localUTrend: Local linear sea level trend used for
data shifting (unit: mm/yr or in/yr)
- startDate: Start date of analysis period
- endDate: End date of analysis period
- validDays: Count of days with valid daily maximums
- totalDays: Total days in the analysis period
- percentValidDays: Percentage of valid days
- long_term_flag: Indicates if station is long-term
- short_term_flag: Indicates if station is short-term
- probabilitiesUnit: Unit for return level and
confidence interval (meters/feet)
- ewlProbabilities: return period (r1), the return level
(value), the upper (ci_high) and lower (ci_low) bound of the
90% confidence interval
Sea Level Trends
- Input Parameters
- station: 7-digit US station ID or Global station ID
with a "-" as the fourth character (if omitted, all stations
are returned)
- affil: Station affiliation, is either "Global" or "US"
(if omitted, all station are returned)
- Output
- Station ID
- Station Name
- Affiliation
- Latitude
- Longitude
- Trend
- Trend Error
- Units
- Start Date
- End Date
Sea Level Rise Projections
- Input Parameters
- station: 7-digit US station ID or Global station ID
- affil: Station affiliation, is either "Global" or "US"
- projection_year: Default is all years
- coastal_flag: default is 1
- station_or_grid: Valid inputs are 'station', 'grid',
'all'. Default is 'all'
- report_year: Default is latest report year
- units: Valid inputs are 'english' or 'metric'. Default
is metric.
- scenario: Valid inputs are 'all', 'low',
'intermediate-low', 'intermediate', 'intermediate-high',
'high', or 'extreme'. Default is 'all'.
- format: Valid inputs are 'xml' or 'json'. Default is
'json'
- page: Default is '1'
- lat
- lon
- min_lat: Minimum Latitude
- max_lat: Maximum Latitude
- min_lon: Minumum Longitude
- max_lon: Maximum Longitude
- Output
- Station Id
- Station Name
- Latitude
- Longitude
- Units
- PSMSL ID
- Scenario
- Report Year
- Projection Year
- Coastal Flag
- Background RSL Per Year
- Projection RSL
- Projection CI Low
- Projection CI High
Sea Level Rise
Projection Offsets
- Input Parameters
- station: 7-digit US station ID or Global station ID
- affil: Station affiliation, is either "Global" or "US"
- report_year: Default is latest report year
- units: Valid inputs are 'english' or 'metric'. Default
is metric.
- format: Valid inputs are 'xml' or 'json'. Default is
'json'
- Output
- Station Id
- Latitude
- Longitude
- Units
- Site Name
- PSMSL ID
- Report Year
- Offset Name
- Offset
High Tide Flooding - Daily Flood Count
- Input Parameters
- station: 7-digit station ID, required
- start_date: start date in format YYYYMMDD, required
- end_date: end date in format YYYYMMDD, required
- units: Output units (english/metric, if omitted,
english units are used)
- datum: Datum reference, (valid options include: "STND",
"MLLW", "MHHW", "GT", "MSL", "MLW", "MHW", not case-sensitive.,
if omitted, STND is used)
- Output
- Station ID
- Station Name
- Latitude
- Longitude
- Units
- Day
- Daily Maximum Water Level
- Time of Daily Maximum Water Level
- The flag that the water level exceeds the major flood
threshold
- The flag that the water level exceeds the moderate
flood threshold
- The flag that the water level exceeds the minor flood
threshold
- The flag that indicates the data is missing
High Tide Flooding - Monthly Flood Count
- Input Parameters
- station: 7-digit station ID, required
- start_date: start date in format YYYYMMDD, optional
- end_date: end date in format YYYYMMDD, optional
- year: 4-digit calendar year number, optional
- range: year range, (if omitted, 0 is used)
- month: month number from 1-12, optional
- Output
- Station ID
- Station Name
- Latitude
- Longitude
- Year
- Month
- The number of flood days that exceed the major flood
threshold each month
- The number of flood days that exceed the moderate flood
threshold each month
- The number of flood days that exceed the minor flood
threshold each month
- The number of days that the flood data is missing each
month
High Tide Flooding - Seasonal Flood Count
- Input Parameters
- station: 7-digit station ID, required
- year: 4-digit calendar year number (if omitted, all
years are returned)
- range: year range (if omitted, 0 is used)
- season: season number 1-Winter, 2-Spring, 3-Summer,
4-Fall, (if omitted, all seasons are returned)
- season_months: season months DJF-Winter, MAM-Spring,
JJA-Summer, SON-Fall, (if omitted, all seasons are returned)
- Output
- Station ID
- Station Name
- Latitude
- Longitude
- Year
- Season ID
- Season Name
- Season Months
- The number of flood days that exceed the major flood
threshold each season
- The number of flood days that exceed the moderate flood
threshold each season
- The number of flood days that exceed the minor flood
threshold each season
- The number of days that the flood data is missing each
season
High Tide Flooding - Annual Flood Count
- Input Parameters
- station: 7-digit station ID (if omitted, all stations
are returned)
- year: 4-digit calendar year number (if omitted, all
years are returned)
- range: year range (if omitted, 0 is used)
- Output
- Station ID
- Station Name
- Latitude
- Longitude
- Year
- The number of flood days that exceed the major flood
threshold every annual year
- The number of flood days that exceed the moderate flood
threshold every annual year
- The number of flood days that exceed the minor flood
threshold every annual year
- The number of days that the flood data is missing every
annual year
High Tide Flooding - Met Year Flood Count
- Input Parameters
- station: 7-digit station ID (if omitted, all stations
are returned)
- met_year: 4-digit meteorological year number (if
omitted, all years are returned)
- range: year range (if omitted, 0 is used)
- Output
- Station ID
- Station Name
- Latitude
- Longitude
- The Meteorological Year
- The number of flood days that exceed the major flood
threshold every annual year
- The number of flood days that exceed the moderate flood
threshold every annual year
- The number of flood days that exceed the minor flood
threshold every annual year
- The number of days that the flood data is missing every
annual year
High Tide Flooding - Next Met Year Annual
Outlook
- Input Parameters
- station: 7-digit station ID (if omitted, all stations
are returned)
- met_year: 4-digit meteorological year number (if
omitted, all years are returned)
- range: year range (if omitted, 0 is used)
- Output
- Station ID
- Station Name
- Latitude
- Longitude
- Met Year
- The number of projected minor flood days for the next
meteorological year. The projection +1 std.
- The number of projected minor flood days for the next
meteorological year. The projection -1 std.
- The number of flood days that exceed the minor flood
threshold every annual year
- The date when the next met-year annual outlook was
calculated.
- The method used to calculate the projection for the
next met-year annual outlook.
High Tide Flooding - Projected Floods Per Year
Per Scenario
NOAA's Center for Operational
Oceanographic Products & Services will no longer be disseminating
this data set through the Derived Product API web service. For
more information, please contact Tide.Predictions@noaa.gov
High Tide Flooding - Decadal Projections
Projected Minor/disruptive, Moderate/typically damaging,
and Major/often destructive High Tide Flooding days by sea level
rise scenario per decade.
- Input Parameters
- station: 7-digit station ID (if omitted, all stations
are returned)
- decade: 4-digit decade number ending with 0 (if
omitted, all decades are returned)
- range: Decade range (if omitted, 0 is used; e.g.,
decade=2050&range=5
returns data for six decades: 2050–2090)
- flood_threshold: NOS threshold used for estimating
projected high tide flooding days (minor, moderate, major; if
omitted, all thresholds are returned)
- Output Parameters
- stnId: 7-digit station ID
- stnName: Name of the station
- lat: Latitude in decimal format
- lon: Longitude in decimal format
- DecadalProjection: Decadal HTF projection above the
'minor', 'moderate' or 'major' NOS thresholds
- decade: Reference decade
- Source: Reference used for computation of the
projections
- low: Projected flooding days under low sea level
scenario (days)
- intLow: Projected flooding days under intermediate-low
sea level scenario (days)
- intermediate: Projected flooding days under
intermediate sea level scenario (days)
- intHigh: Projected flooding days under
intermediate-high sea level scenario (days)
- high: Projected flooding days under high sea level
scenario (days)
High Tide Flooding - Record Days and Typical HTF
Days in 2000
- Input Parameters
- station: 7-digit station ID (if omitted, all stations
are returned)
- Output
- Station ID
- Station Name
- Report Year
- Record Year
- Record High Tide Flooding(HTF) Day
- Observed Period
- Typical HTF Days in 2000
- Tied (1' if record year is tied for record HTF day, '0'
if no tie)
High Tide Flooding - Likely Decadal Scenarios
Projected Minor/disruptive, Moderate/typically damaging,
and Major/often destructive High Tide Flooding days by Regional
Likely sea level rise scenario for 2050.
- Input Parameters
- station: 7-digit station ID (if omitted, all stations
are returned)
- decade: 4-digit decade number ending with 0 (if
omitted, all decades are returned)
- flood_threshold: NOS threshold used for estimating
projected high tide flooding days (minor, moderate, major; if
omitted, all thresholds are returned)
- Output Parameters
- stnId: 7-digit station ID
- stnName: The name of the station
- lat: Latitude in decimal format
- lon: Longitude in decimal format
- LikelyDecadalScenarios: Decadal HTF projection above
the 'minor', 'moderate', or 'major' NOS thresholds
- year: Reference decade (2050)
- Source: Reference used for computation of the
projections
- lower_bound: Lower bound of most likely high tide
flood days
- upper_bound: Upper bound of most likely high tide
flood days
- lower_scenario: The most likely lower bound scenario
- upper_scenario: The most likely upper bound scenario
High Tide Flooding - Daily Likelihoods
- Input Parameters
- station: 7-digit station ID (required for specific
station)
- start_date: start date in format YYYYMMDD (required
with station Id)
- end_date: end date in format YYYYMMDD(required with
station Id)
- date: specific date in format YYYYMMDD(required for
specific date)
- station_flood: flood possibility for the specific date.
'any', 'true', 'false' (if omitted, all possibilities return).
- dissemination: dissemination value of the station. '0',
'1', 'all' (if omitted, all with dissemination equal to 1
return).
- range: day range (if omitted, 0 is used)
- units: Output units (english/metric, if omitted,
english units are used)
- datum: Datum reference
(STND/MHHW/MHW/MSL/MTL/MLW/MLLW/NAVD, not case-sensitive, if
omitted, MHHW is used)
- Output
- Station ID
- Station Name
- Latitude
- Longitude
- Region
- Count
- Date (date likelihood produced for)
- Flood (likelihood score indicates potential for
flooding: true / false)
- Likelihood (percent)
- Flood threshold (m)
- Distance to threshold (m)
- Updated date (Date the likelihoods were last updated by
the model)
- Dissemination (Returns only when dissemination is 'all'
: 0/ 1)
High Tide Flooding - Daily Likelihoods Text
- Input Parameters
- region: Region reference (Northeast, Mid-Atlantic, Gulf
Coast, West Coast, Pacific Islands, Alaska, Southeast and
Caribbean Islands)
- year: 4-digit calendar year number (if omitted, all
years are returned)
- month: month in format MM (if omitted, all months are
returned)
- Output
- Region
- Year
- Month
- Reason
- Impact
High Tide Flooding - Monthly Maximum Likelihoods
- Input Parameters
- station: 7-digit station ID (required for specific
station)
- start_date: start date in format YYYYMMDD or YYYYMM
- end_date: end date in format YYYYMMDD or YYYYMM
- dissemination: dissemination value of the station. '0',
'1', 'all' (if omitted, all with dissemination equal to 1
return).
- units: Output units (english/metric, if omitted,
english units are used)
- datum: Datum reference
(STND/MHHW/MHW/MSL/MTL/MLW/MLLW/NAVD, not case-sensitive, if
omitted, MHHW is used)
- Output
- Station ID
- Station Name
- Latitude
- Longitude
- Region
- Count
- Month
- Year
- Maximum date (date of the maximum likelihood for the
month)
- Flood (likelihood score indicates potential for
flooding: true / false)
- Maximum likelihood (percent)
- Flood threshold (m)
- Distance to threshold (m)
- Updated date (Date the likelihoods were last updated by
the model)
- Dissemination (Returns only when dissemination is 'all'
: 0/ 1)
Current Predictions Annual Report
- Input Parameters
- station: 7-digit station ID (required for specific
station)
- year: format YYYY
- format: pdf, csv, txt, xml
- time-zone: LST_LDT, LST, GMT
- units: 1 (english), 0 (metric)
- date-timeUnits: am/pm, 24hr
- Output
- Current Predictions Report