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
    • Yearly inundation statistics
    • Extreme Water Levels
    • Sea Level Trends
  • 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)

Yearly Inundation Statistics

  • Input Parameters
    • name: annualflooddays
    • station: 7-digit station ID (if omitted, all stations are returned)
    • year: Specify a year for retrieval (if omitted, all years are returned)
  • Output
    • Station ID
    • Station Name
    • Year
    • Days (number of days where hourly water levels exceeded minor flood index threshold)

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

Examples

Top Ten Water Levels

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

Yearly Inundation Statistics

RequestLink
Retrieve annual flood days for all stations (JSON) http://tidesandcurrents.noaa.gov/dpapi/latest/webapi/product.json?name=annualflooddays
Retrieve annual flood days for all stations (XML) http://tidesandcurrents.noaa.gov/dpapi/latest/webapi/product.xml?name=annualflooddays
Retrieve annual flood days for one station http://tidesandcurrents.noaa.gov/dpapi/latest/webapi/product.json?name=annualflooddays&station=8638610
Retrieve flood days in one year http://tidesandcurrents.noaa.gov/dpapi/latest/webapi/product.json?name=annualflooddays&year=2015

Extreme Water Levels

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

Sea Level Trends

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

Contact Us

Email: co-ops.userservices@noaa.gov