Introduction

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".

Release Notes

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
    • JSON
    • XML

Products

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)
  • 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)

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)

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

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
    • 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
    • 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
    • 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
    • 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
    • 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
    • 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

  • 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
    • Year
    • The source that the project is based on
    • The lowest scenario
    • The intermediate-low scenario
    • The intermediate scenario
    • The intermediate-high scenario
    • The highest scenario
    • The extreme scenario

High Tide Flooding - Decadal Projections

  • 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)
  • Output
    • Station ID
    • Station Name
    • Decade
    • The source that the project is based on
    • The intermediate-low scenario
    • The intermediate scenario

Examples

Top Ten Water Levels

RequestLink
Retrieve all top ten values for all stations (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=toptenwaterlevels
Retrieve all top ten values for all stations (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.xml?name=toptenwaterlevels
Retrieve top ten values for one station (english) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=toptenwaterlevels&station=8638610&units=english
Retrieve top ten values for one station (metric) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=toptenwaterlevels&station=8638610&units=metric

Extreme Water Levels

RequestLink
Retrieve all extreme water level values for all stations (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=extremewaterlevels
Retrieve all extreme water level values for all stations (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.xml?name=extremewaterlevels
Retrieve extreme water level values for one station (english) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=extremewaterlevels&station=8638610&units=english
Retrieve extreme water level values for one station (metric) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=extremewaterlevels&station=8638610&units=metric

Sea Level Trends

RequestLink
Retrieve sea level trends (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/sealvltrends.json
Retrieve sea level trends (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/sealvltrends.xml
Retrieve sea level trends for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/sealvltrends.json?station=8638610
Retrieve sea level trends for one station (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/sealvltrends.xml?station=8638610
Retrieve sea level trends for only US stations (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/sealvltrends.json?affil=US
Retrieve sea level trends for only US stations (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/sealvltrends.xml?affil=US
Retrieve sea level trends for only global stations (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/sealvltrends.json?affil=Global
Retrieve sea level trends for only global stations (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/sealvltrends.xml?affil=Global

High Tide Flooding - Daily Flood Count

RequestLink
Retrieve daily flood count and max wl value and time records for one station during a specified time period (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_daily.json?station=1612340&start_date=20160101&end_date=20181231
Retrieve daily flood count and max wl value on datum MLLW and time records for one station during a specified time period (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_daily.xml?station=1612340&start_date=20160101&end_date=20181231&datum=mllw
Retrieve daily flood count and max wl value and time records for one station during a specified time period (english) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_daily.json?station=8638610&start_date=20160101&end_date=20181231&units=english
Retrieve daily flood count and max wl value and time records for one station during a specified time period (metric) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_daily.json?station=8638610&start_date=20160101&end_date=20181231&units=metric

High Tide Flooding - Monthly Flood Count

RequestLink
Retrieve monthly flood count records for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_monthly.json?station=8638610
Retrieve monthly flood count records for one station (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_monthly.xml?station=8638610
Retrieve monthly flood count records for a specified year for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_monthly.json?station=1612340&year=2010
Retrieve monthly flood count records for a specified year and month for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_monthly.json?station=1612340&year=2010&month=3
Retrieve monthly flood count records during a specified period for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_monthly.json?station=1612340&start_date=19960315&end_date=19981125
Retrieve a station's monthly flood count records for a specified month within a specified period (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_monthly.json?station=8575512&start_date=19960315&end_date=20001125&month=3
Retrieve monthly flood count records for one station within a specified year range (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_monthly.json?station=8575512&year=2010&range=5
Retrieve monthly flood count records for a specified month during a specified year range (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_monthly.json?station=8575512&year=2010&range=5&month=7

High Tide Flooding - Seasonal Flood Count

RequestLink
Retrieve seasonal flood count records for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_seasonal.json?station=8638610
Retrieve seasonal flood count records for one station (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_seasonal.xml?station=8638610
Retrieve seasonal flood count records for a specified year for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_seasonal.json?station=8638610&year=2010
Retrieve seasonal flood count records for a specified year and season for one station (query by season ID) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_seasonal.json?station=8638610&year=2010&season=3
Retrieve seasonal flood count records for a specified year and season for one station (query by season months) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_seasonal.json?station=8638610&year=2010&season_months=DJF
Retrieve seasonal flood count records for a specified season for one station (season ID) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_seasonal.json?station=8638610&season=3
Retrieve seasonal flood count records for a specified season(season months) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_seasonal.json?station=8638610&season_months=MAM
Retrieve seasonal flood count records for one station within a specified year range (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_monthly.json?station=8575512&year=2010&range=5

High Tide Flooding - Annual Flood Count

RequestLink
Retrieve annual flood count records (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_annual.json
Retrieve annual flood count records for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_annual.json?station=8638610
Retrieve annual flood count records for one station (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_annual.xml?station=8638610
Retrieve annual flood count records for a specified year for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_annual.json?station=8638610&year=2010
Retrieve annual flood count records for a specified year (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_annual.json?year=2010
Retrieve annual flood count records for a specified year range(JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_annual.json?year=2010&range=5
Retrieve annual flood count records for a specified year range for one station(JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_annual.json?station=8638610&year=2010&range=5

High Tide Flooding - Met Year Flood Count

RequestLink
Retrieve met year flood count records (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual.json
Retrieve met year flood count records for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual.json?station=8638610
Retrieve met year flood count records for one station (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual.xml?station=8638610
Retrieve met year flood count records for a specified meteorological year for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual.json?station=8638610&met_year=2010
Retrieve met year flood count records for a specified meteorological year (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual.json?met_year=2010
Retrieve met year flood count records for a specified meteorological year range(JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual.json?met_year=2010&range=5
Retrieve met year flood count records for a specified meteorological year range for one station(JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual.json?station=8638610&met_year=2010&range=5

High Tide Flooding - Next Met Year Annual Outlook

RequestLink
Retrieve next met year annual outlook (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual_outlook.json
Retrieve next met year annual outlook for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual_outlook.json?station=8638610
Retrieve next met year annual outlook for one station (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual_outlook.xml?station=8638610
Retrieve next met year annual outlook for a specified met year for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual_outlook.json?station=8638610&met_year=2020
Retrieve next met year annual outlook for a specified met year (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual_outlook.json?met_year=2020
Retrieve next met year annual outlook for a specified met year range(JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual_outlook.json?met_year=2019&range=2
Retrieve next met year annual outlook for a specified met year range for one station(JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_met_year_annual_outlook.json?station=8638610&met_year=2019&range=2

High Tide Flooding - Projected Floods Per Year Per Scenario

RequestLink
Retrieve annual projected floods (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_annual.json
Retrieve annual projected floods for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_annual.json?station=8638610
Retrieve annual projected floods for one station (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_annual.xml?station=8638610
Retrieve annual projected floods for a specified year for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_annual.json?station=8638610&year=2030
Retrieve annual projected floodsfor a specified year (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_annual.json?year=2030
Retrieve annual projected floods for a specified year range(JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_annual.json?year=2030&range=5
Retrieve annual projected floods for a specified year range for one station(JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_annual.json?station=8638610&year=2030&range=5

High Tide Flooding - Decadal Projections

RequestLink
Retrieve decadal projections (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_decadal.json
Retrieve decadal projections for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_decadal.json?station=8638610
Retrieve decadal projections for one station (XML) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_decadal.xml?station=8638610
Retrieve decadal projections for a specified decade for one station (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_decadal.json?station=8638610&decade=2050
Retrieve decadal projections for a specified decade (JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_decadal.json?decade=2050
Retrieve decadal projections for a specified decade range(JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_decadal.json?decade=2050&range=5
Retrieve decadal projections for a specified decade range for one station(JSON) https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_projection_decadal.json?station=8638610&decade=2050&range=5

Contact Us