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

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)

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

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

• 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 low scenario
• The intermediate-low scenario
• The intermediate scenario
• The intermediate-high scenario
• The high scenario

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

• 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)
• Output
• Station ID
• Station Name
• Year
• The source that the project is based on
• The most likely high tide flood days (lower bound)
• The most likely high tide flood days (upper bound)
• The most likely lower bound 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)
• Output
• Station ID
• Station Name
• Region
• Count
• Date (date likelihood produced for)
• Flood (likelihood score indicates potential for flooding: true / false)
• Likelihood (percent)
• Flood threshold (m, STND)
• 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)
• Output
• Station ID
• Station Name
• 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, STND)
• 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

Peak Water Levels

Request	Link
Retrieve top ten water level values for all stations (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=toptenwaterlevels
Retrieve top ten water level values for all stations (XML)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.xml?name=toptenwaterlevels
Retrieve top ten water level values for one station (english)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=toptenwaterlevels&station=8638610&units=english
Retrieve top ten water level values for one station (metric)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=toptenwaterlevels&station=8638610&units=metric
Retrieve top ten water level values for one station (datum)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=toptenwaterlevels&station=8638610&units=metric&datum=mhhw
Retrieve all peak water level events (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=peakwaterlevels
Retrieve all peak water level events (XML)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.xml?name=peakwaterlevels
Retrieve peak water level events for a specific year	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=peakwaterlevels&year=2018
Retrieve station peak water levels for a specific event id (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=peakwaterlevels&eventid=804
Retrieve station peak water levels for a specific event id (XML)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.xml?name=peakwaterlevels&eventid=804
Retrieve station peak water levels for a specific event id (english)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=peakwaterlevels&eventid=804&units=english
Retrieve station peak water levels for a specific event id (metric)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=peakwaterlevels&eventid=804&units=metric
Retrieve station peak water levels for a specific event id (datum)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product.json?name=peakwaterlevels&eventid=804&units=metric&datum=mhhw

Extreme Water Levels

Request	Link
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

Request	Link
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

Sea Level Rise Projections

Request	Link
Retrieve SLR projections (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/slr_projections.json
Retrieve SLR projections (XML)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/slr_projections.xml
Retrieve Page 5 of SLR projections(JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/slr_projections.json?page=5
Retrieve SLR projections for one station by NOS ID (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/slr_projections.json?affil=US&station=8638610
Retrieve SLR projections for one station by PSMSL ID (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/slr_projections.json?affil=Global&station=10
Retrieve SLR projections by Latitude or Longitude (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/slr_projections.json?lat=53.5&lon=173.5
Retrieve SLR projections by Latitude or Longitude Bounding Box (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/slr_projections.json?min_lat=45&max_lat=65&min_lon=160&max_lon=180
Retrieve SLR projection Offsets (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/slr_projectionOffsets.json
Retrieve SLR projection Offsets for single US station (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/slr_projectionOffsets.json?station=9447130&affil=US&units=english
Retrieve SLR projection Offsets for single Global station (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/product/slr_projectionOffsets.json?station=12&affil=Global

High Tide Flooding - Daily Flood Count

Request	Link
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

Request	Link
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

Request	Link
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

Request	Link
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

Request	Link
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

Request	Link
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 - Decadal Projections

Request	Link
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

High Tide Flooding - Record Days and Typical HTF Days in 2000

Retrieve met year annual record days and typical HTF days in 2000 (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_record.json
Retrieve met year annual record days and typical HTF days in 2000 for one station (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_record.json?station=8638610
Retrieve met year annual record days and typical HTF days in 2000 for a specified year (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_record.json?year=2020

High Tide Flooding - Likely Decadal Scenarios

Request	Link
Retrieve likely decadal scenario projections (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_likely_decadal_scenarios.json
Retrieve likely decadal scenario for one station (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_likely_decadal_scenarios.json?station=8638610
Retrieve likely decadal scenario for one station (XML)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_likely_decadal_scenarios.xml?station=8638610
Retrieve likely decadal scenario for a specified year for one station (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_likely_decadal_scenarios.json?station=8638610&year=2050
Retrieve likely decadal scenario for a specified year (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htf/htf_likely_decadal_scenarios.json?year=2050

High Tide Flooding - Daily Likelihoods

Retrieve flood status for all dates for a specified station (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.json?station=1612340&start_date=20230801&end_date=20241231
Retrieve flood status for all dates for a specified station (XML)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.xml?station=1612340&start_date=20230701&end_date=20241231
Retrieve flood status for all stations for a specified date	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.json?date=20231006&station_flood=any
Retrieve stations with flooding possibility for a specified date	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.json?date=20231006&station_flood=true
Retrieve stations with no flooding possibility for a specified date	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.json?date=20231006&station_flood=false
Retrieve flood status for all stations for a specified range dates	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.json?start_date=20230801&end_date=20241231&station_flood=any
Retrieve stations with flooding possibility for a specified range dates	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.json?start_date=20230801&end_date=20241231&station_flood=true
Retrieve stations with no flooding possibility for a specified range dates	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.json?start_date=20230801&end_date=20241231&station_flood=false
Retrieve flood status for a station of a specified date	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.json?station=1820000&date=20230714&station_flood=any
Retrieve flood status for a range of days for one station	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.json?station=1820000&date=20230714&range=5&station_flood=any
Retrieve flood status for all stations for all available dates	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.json?
Retrieve flood status for all stations for all available dates (metric)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.json?units=metric
Retrieve flood status for all stations & for all available dates with dissemination param	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb.json?dissemination=0

High Tide Flooding - Daily Likelihoods Text

Retrieve all flood status text for all regions(JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb/htb_text.json?
Retrieve all flood status text for all regions(XML)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb/htb_text.xml?
Retrieve flood status text for specified region	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb/htb_text.json?region=Northeast
Retrieve flood status text for specified region and year	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb/htb_text.json?region=Northeast&year=2023
Retrieve flood status text for specified region, year and month	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb/htb_text.json?region=Northeast&year=2024&month=01

High Tide Flooding - Monthly Maximum Likelihoods

=

Retrieve monthly maximum flood status for a specified station and full date range (JSON)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb/htb_monthly_max.json?station=1612340&start_date=20230801&end_date=20241231
Retrieve monthly maximum flood status for a specified station and full date range (XML)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb/htb_monthly_max.xml?station=1612340&start_date=20230801&end_date=20241231
Retrieve monthly maximum flood status for a specified station and monthly date range	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb/htb_monthly_max.json?station=1612340&start_date=202308&end_date=202412
Retrieve monthly maximum flood status for a specified station for all available dates	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb/htb_monthly_max.json?station=1612340
Retrieve monthly maximum flood status for all stations for a specified date range	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb//htb_monthly_max.json?start_date=20230801&end_date=20241231
Retrieve monthly maximum flood status for all stations for a specified date range (metric)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb//htb_monthly_max.json?start_date=20230801&end_date=20241231&units=metric
Retrieve monthly maximum flood status for all stations for all available dates	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb/htb_monthly_max.json?
Retrieve monthly maximum flood status for all stations for all available dates with dissemination param	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/htb/htb_monthly_max.json?dissemination=all

Current Predictions Annual Report

Retrieve Current Prediction Annual Report, with time units set to AM/PM(TXT)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/currentPredictionsAnnualReport/?id=EPT0003_14&year=2023&format=txt&time-zone=LST_LDT&units=2&date-timeUnits=am/pm
Retrieve Current Prediction Annual Report, with time units set to 24 Hours(PDF)	https://api.tidesandcurrents.noaa.gov/dpapi/prod/webapi/currentPredictionsAnnualReport/?id=EPT0003_14&year=2023&format=pdf&time-zone=LST_LDT&units=2&date-timeUnits=24hr

Email: co-ops.userservices@noaa.gov