CO-OPS Metadata API v1.0

The CO-OPS Metadata API (MDAPI) can be used to retrieve information about CO-OPS' stations. A request can be made to return information about a specific station, or information about multiple stations can be returned. The types of information accessible via the API are listed in detail under the heading "Resource Types".

Version 1.0 - First Major Production Release


** New Feature
    * [MDAPI-246] - Add NOS Flood Thresholds to MDAPI water level stations metadata
    * [MDAPI-257] - Add visibility stations as a new "type"
    * [MDAPI-263] - Add historical MET and PhyOcean station list with removed date
    * [MDAPI-264] - Add Currents harmonic constituents to the metadata API
    * [MDAPI-272] - Add end points for high/ low water station list
    * [MDAPI-274] - Add newly created station parameter for display of OFS data on CID to MDAPI
    * [MDAPI-305] - MDAPI Enhancements to Support High Tide Flooding type stations

View previous release notes

Requests to the metadata API are structured in one of the following ways:
A single station record:

https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/id.extension
https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/9414290.json

https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/id/resource.extension
https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/1611400/datums.json

Multiple station records:

https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations.extension
https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations.xml

https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations.extension?type=type
https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations.json?type=currents

PORTS list:

https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/ports.extension
https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/ports.json

PORTS Station list:

https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/portsstation.extension
https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/portsstation.json
https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/portsstation.extension?ports=ports
https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/portsstation.json?ports=cs

PORTS Plots list:

https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/portsplots.extension
https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/portsplots.json
https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/portsplots/id.extension
https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/portsplots/8594900.json

COOP Mode:

https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/mode.extension
https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/mode.json

A unique alphanumeric identifier of a CO-OPS or partner station. For a list of stations, see:

You can also browse stations on the CO-OPS Station Map.
Examples:

9414290 San Francisco, CA
1611400 Nawiliwili, HI
9075065 Alpena, MI
cb0102 Cape Henry LB 2CH

Information about a station is organized into discrete areas. These areas can be queried using the following identifiers:

Non-Current meter stations
Option	Description
datums	Water level datums. A datum is a base elevation used as a reference from which to reckon heights or depths.
supersededdatums	Superseded water level datums. Datums from the previous epoch.
harcon	Harmonic constituents used for tide predictions or current predictions (station dependent).
sensors	Installed observing sensors at a station, including status and any messages related to an outage.
details	Installation date, removal date, and other details about a station.
notices	Station specific notices.
disclaimers	Disclaimers relevant to this station.
benchmarks	Fixed physical objects or marks used as a reference for a horizontal or vertical datum.
tidepredoffsets	Offsets used in the calculation of tidal predictions.
floodlevels	NOS and NWS flood thresholds.

Current meter stations
Option	Description
notices	Station specific notices.
disclaimers	Disclaimers relevant to this station.
bins	Discrete depths at which data are collected.
deployments	Periods at which an instrument is collecting data at a given location.

Tide Prediction stations
Option	Description
tidepredoffsets	Offsets used in the calculation of tidal predictions.

Current Prediction stations
Option	Description
currentpredictionoffsets	Offsets used in the calculation of tidal current predictions.

"Benchmarks" resource with format set to JSON.

      Excerpt from https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/1611400/benchmarks.json
      ...
      {
         "benchmarkList": [
            {
               "designation": "161 1400 TIDAL 5",
               "vm": 8,
               "latitude": 21.954779,
               "longitude": -159.35353,
               "description": "The bench mark is set in concrete walk leading to the State of Hawaii Marine Harbor Patrol Boat Station Pier, 42 m (138 ft) south of the wharf face line of Pier 1, 3.05 m (10.0 ft) west of the west side of the Marine Patrol Building, and 0.15 m (0.5 ft) from the west end of concrete walk.",
               "published": true
            },
      ...

The API supports two output formats: JSON, and XML.
Output format can be specified by an extension in your request's URL, or by setting the "Accept" header of your request to the appropriate type.

Note! Most modern web browsers will automatically send an "Accept" header containing "application/xml". This means that leaving the format extension off of the URL will default to an XML response when accessing the API through a web browser.

Output Formats
URL Option	Header Option	Description
.json	application/json	JSON (JavaScript Object Notation) is a lightweight data-interchange format. It is easy for humans to read and write. It is easy for machines to parse and generate. For more information see www.json.org
.xml	application/xml	Extensible Markup Language (XML) is a markup language that defines a set of rules for encoding documents in a format that is both human-readable and machine-readable.

"Stations" resource with type set to 'waterlevels' and output format set to XML, in english units.

      Excerpt from https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations.xml?type=waterlevels&units=english
      ...
      <Stations>
      <count>420</count>
      <Station xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="waterLevelStation" self="https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/1611400.xml">
         <id>1611400</id>
         <name>Nawiliwili</name>
         <lat>21.954506</lat>
         <lng>-159.3561</lng>
      ...

CO-OPS offers many different products. Many of these products are dependent upon a certain type of sensor being installed at the station. By specifying a 'type' when requesting a list of stations, the collection that is returned will include only stations with the required type.

Station Collection Types
Option	Description
waterlevels	Stations that actively measure water levels
historicwl	Stations that have measured water levels in the past. This includes active stations.
met	Stations that have one or more meteorological sensors installed, such as air temperature.
waterlevelsandmet	Combined results of waterlevels and met types. Results in a list of active stations, excluding current meters.
tidepredictions	Stations that offer tide predictions based on harmonic analysis.
harcon	Water level stations with measured harmonic constituents.
datums	Water level stations with datums.
supersededdatums	Water level stations with superseded datums.
benchmarks	Water level stations with published benchmarks.
supersededbenchmarks	Water level stations with superseded benchmarks.
currents	Real-time current meter stations that are presently deployed and are actively measuring currents.
historiccurrents	Current meter stations that are no longer deployed, such as historic real-time stations that have been uninstalled or short-term survey stations.
surveycurrents	Short-term current meter stations that collected data for a limited time in order improve tidal current predictions or support operational forecast models.
currentpredictions	Current meter stations for which tidal current predictions are available.
cond	Stations that have conductivity sensors installed.
watertemp	Stations that have water temperature sensors installed.
physocean	Stations that have a physical oceanography(water temperature/conductivity) sensor installed.
tcoon	Stations that are affiliated with the Texas Coastal Ocean Observation Network (TCOON).
1minute	Stations that have 1 minute water level data.
airgap	Stations that have air gap data.
visibility	Stations that have visibility sensors installed.
highwater	Stations that are in High Water Alert.
lowwater	Stations that are in Low Water Alert.
hightideflooding	Stations have High Tide Flooding data available and flood thresholds initially.

"Stations" resource with type set to 'waterlevels'

      Excerpt from https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations.json?type=waterlevels
      ...
      "count": 420,
      "stationList": [
         {
            "id": "1611400",
            "name": "Nawiliwili",
            "lat": 21.954506,
            "lng": -159.3561,
            "tidal": true,
            "greatlakes": false,
            "state": "HI",
            "affiliations": "NWLON",
            "details": {
               "self": "https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/1611400/details.json"
            },
      ...

When figures are returned as part of a record, the units they are returned in are configurable, where applicable:

Unit Options
Option	Description
english	Feet
metric	Meters

"Bins" resource of station 'cb0102' with units set to 'metric'. Affected fields are highlighted in red.

      Excerpt from https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/cb0102/bins.json?units=metric
      ...
      "self": "http://https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/cb0102/bins.json",
      "nbr_of_bins": 20,
      "units": "meters",
      "binList": [
         {
            "bin": 1,
            "depth": 11.7,
            "qc_flag": 1,
            "center_bin_1_dist": 1.4,
            "orientation": "up",
            "bin_size": 1.0
         },
      ...

PORTS Codes are two letters to represents a certain PORTS:

Example PORTS Code:
PORTS Code	Description
ca	Cape Cod PORTS
ch	Charleston Harbor PORTS

Normally a station record will be returned including a number of links to resources relevant to the station. The expand field can be used to automatically retrieve these resources and embed them within the results of the original request. Valid fields are denoted by the "expand" field of output.

"Details" resource and "expand" field of a station record with no expand specified:

      Excerpt from https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/1611400.json
      ...
      "details": {
        "self": "https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/1611400/details.json"
      },
      "expand": "details,sensors,datums,supersededdatums,tidepredoffsets,products,disclaimers,notices,nearby"
      ...

"Details" resource with "expand=details" appended to request for a station record:

      Excerpt from https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/1611400.json?expand=details
      ...
      "details": {
      "self": "https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/1611400/details.json",
      "id": "1611400",
      "established": "1954-11-24 00:00:00.0",
      "removed": "",
      "noaachart": "19383",
      "timemeridian": -150,
      "timezone": 10.0,
      "origyear": "1800-02-01 00:00:00.0"
      },
      ...

More than one option can be passed to the "expand" parameter by separating options with a comma.

      Excerpt from https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/1611400.json?expand=details,sensors
      ...
      "details": {
        "self": "https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/1611400/details.json",
        "id": "1611400",
        "established": "1954-11-24 00:00:00.0",
        "removed": "",
        "noaachart": "19383",
        "timemeridian": -150,
        "timezone": 10.0,
        "origyear": "1800-02-01 00:00:00.0"
      },
      "sensors": {
        "self": "https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/1611400/sensors.json",
        "sensorList": [
          {
            "status": 1,
            "refdatum": "",
            "sensorID": "A1",
            "name": "",
            "message": "",
            "dcp": 1
          },
      ...

Expand options
Option	Single Record Requests	Multi-Record Requests
details
sensors
products
disclaimers
notices
datums
supersededdatums
harcon
tidepredoffets
benchmarks
nearby
bins
deployments
currentpredictionoffsets
floodlevels

Only applicable to requests for nearby stations. If not specified, the radius of the search will be 2 nautical miles.

Radius
Option	Description
Any positive number	Distance in nautical miles to return nearby stations from.

"Nearby" resource with "radius=3" appended to request for a station record:

      Excerpt from https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/9414290/nearby.json?radius=3
      ...
      {
         "count": 17,
         {
            "stationType": "Meteorological",
            "distance": 7.169938,
            "id": "9414769",
            "name": "Oakland Middle Harbor, CA",
            "lat": 37.8,
            "lng": -122.33,
            "self": "https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/9414769.json"
         },
      ...

Only applicable to requests for currents station harmonic constituents. If not specified, all the bins will be returned.

Bin
Option	Description
Any positive integer	Harmonic Constituent bin number.

"bin" parameter appended to request for a current station's harmonic constituents:

      Excerpt from https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/cb0102/harcon.json?bin=4
      ...
      {
        "units": "feet, knots",
        "HarmonicConstituents": [
          {
            "binNbr": 4,
            "binDepth": 21.7,
            "constNum": 1,
            "constituentName": "M2",
            "description": "Principal lunar semidiurnal constituent",
            "majorAmplitude": 1.033,
            "majorPhase": 253.3,
            "minorAmplitude": 0.076,
            "minorPhase": 355.0,
            "majorMeanSpeed": 0.025,
            "minorMeanSpeed": 0.01
          },
      ...

Basic requests
Request	Link
Active water level stations in XML	https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations.xml?type=waterlevels
Active current meter stations in JSON	https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations.json?type=currents
Station details for 9414290, San Francisco CA in XML	https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/9414290/details.xml
Benchmarks for 1611400, Nawiliwili, HI in JSON	https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/1611400/benchmarks.json

Advanced requests
Request	Link
Water level station 9414290, San Francisco CA with station details and sensors included, with metric units, in JSON	https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/9414290.json?expand=details,sensors&units=metric
Current meter cb0102, Cape Henry LB 2 CH with deployments included, with english units, in JSON	https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations/cb0102.json?expand=deployments&units=english

Records are comprised of individual fields and references to other resources. These resources each have unique sets of fields containing data.

Name	Type	Description
count	Integer	The number of stations returned for the request.
stationList	Array	The collection of stations. Returns as a collection of <Station> elements in XML, or as an array titled 'stations' in JSON.
self	String	A unique URL pointing to this resource

Name	Type	Description
tidal	boolean	Whether or not the station is tidal.
greatlakes	boolean	Whether or not the station is in the Great Lakes region.
shefcode	String	SHEF code for NWS reference.
details	URL	A unique URL to a list of details about the station.
sensors	URL	A unique URL to a list of sensors configured at the station.
floodlevels	URL	A unique URL to a list of flood levels configured at the station.
datums	URL	A unique URL to a list of datums applicable to the station.
supersededdatums	URL	A unique URL to a list of supersededdatums applicable to the station.
harmonicConstituents	URL	Harmonic constituents for tidal prediction.
benchmarks	URL	A unique URL to a list of benchmarks applicable to the station.
tidePredOffsets	URL	Tide prediction offsets
ofsMapOffsets	URL	OFS map offsets
state	String	The state or region code that the station resides within.
timezone	String	The time zone name for the station.
timezonecorr	Integer	The time zone corr number for the station.
observedst	boolean	Whether or not the station uses Daylight saving time.
stormsurge	Boolean	Whether or not the station is in storm surge mode.
nearby	URL	A unique URL to a list of nearby stations.
forecast	Boolean	Whether or not the forecast data should be displayed for the station.
outlook	boolean	Whether or not the station has HTF outlook products.
HTFhistorical	boolean	Whether or not the station has historical HTF data.
nonNavigational	boolean	Whether or not the station is nonNavigational.
id	String	A unique alphanumeric ID specific to this station.
name	String	The name of the station
lat	Float	Latitude in decimal format
lng	Float	Longitude in decimal format
affiliations	String	A comma separated list of programs or partnerships the station is affiliated with
portscode	String	A two character code indicating the station is a member of a Physical Oceanographic Real-Time System (PORTS)
products	URL	A unique URL to a list of name/URL pairs for web products offered by CO-OPS
disclaimers	URL	A unique URL to a list of disclaimers relevant to the station.
notices	URL	A unique URL to a list of station-specific notices.
self	String	A unique URL pointing to a record of the station
expand	String	A comma separated list of values valid for expansion (see expansion).
tideType	String	Station Tide Type.

Name	Type	Description
state	String	The state or region code that the station resides within.
tidepredoffsets	URL	A unique URL referencing tide prediction offsets for this station.
type	String	R for reference stations, S for subordinate stations.
timemeridian	Integer	Time meridian
reference_id	String	A unique alphanumeric ID referencing a subordinate station's reference station, if applicable
timezonecorr	Integer	The time zone corr number for the station.
id	String	A unique alphanumeric ID specific to this station.
name	String	The name of the station
lat	Float	Latitude in decimal format
lng	Float	Longitude in decimal format
affiliations	String	A comma separated list of programs or partnerships the station is affiliated with
portscode	String	A two character code indicating the station is a member of a Physical Oceanographic Real-Time System (PORTS)
products	URL	A unique URL to a list of name/URL pairs for web products offered by CO-OPS
disclaimers	URL	A unique URL to a list of disclaimers relevant to the station.
notices	URL	A unique URL to a list of station-specific notices.
self	String	A unique URL pointing to a record of the station
expand	String	A comma separated list of values valid for expansion (see expansion).
tideType	String	Station Tide Type.

Name	Type	Description
project	String	Project the station is associated with.
deployed	String	When the station was deployed.
retrieved	String	When the station was retrieved, if applicable.
timezone_offset	String	Timezone offset.
observedst	boolean	Project type, either 'PORTS' or 'Survey'
project_type	String	whether this station observes Daylight Saving Time
noaachart	Integer	NOAA Chart#
deployments	URL	A unique URL to a list of deployments.
bins	URL	A unique URL to a list of bins.
harmonicConstituents	URL	Harmonic constituents for current prediction.
id	String	A unique alphanumeric ID specific to this station.
name	String	The name of the station
lat	Float	Latitude in decimal format
lng	Float	Longitude in decimal format
affiliations	String	A comma separated list of programs or partnerships the station is affiliated with
portscode	String	A two character code indicating the station is a member of a Physical Oceanographic Real-Time System (PORTS)
products	URL	A unique URL to a list of name/URL pairs for web products offered by CO-OPS
disclaimers	URL	A unique URL to a list of disclaimers relevant to the station.
notices	URL	A unique URL to a list of station-specific notices.
self	String	A unique URL pointing to a record of the station
expand	String	A comma separated list of values valid for expansion (see expansion).
tideType	String	Station Tide Type.

Name	Type	Description
currentpredictionoffsets	Boolean	A unique URL to a list of current prediction offsets applicable to the station.
currbin	Integer	The bin number selected for use in tidal current predictions.
type	String	Current prediction classification (H=harmonic, S=subordinate, W=weak and variable)
depth	Float	Depth of predictions (in feet)
depthType	String	Depth measurement type ('U' = Unknown, 'B' = below chart datum, 'S' = below surface)
timezone_offset	String	Timezone offset.
harmonicConstituents	URL	Harmonic constituents for current prediction.
id	String	A unique alphanumeric ID specific to this station.
name	String	The name of the station
lat	Float	Latitude in decimal format
lng	Float	Longitude in decimal format
affiliations	String	A comma separated list of programs or partnerships the station is affiliated with
portscode	String	A two character code indicating the station is a member of a Physical Oceanographic Real-Time System (PORTS)
products	URL	A unique URL to a list of name/URL pairs for web products offered by CO-OPS
disclaimers	URL	A unique URL to a list of disclaimers relevant to the station.
notices	URL	A unique URL to a list of station-specific notices.
self	String	A unique URL pointing to a record of the station
expand	String	A comma separated list of values valid for expansion (see expansion).
tideType	String	Station Tide Type.

Name	Type	Description
id	String	A unique alphanumeric ID specific to this station.
name	String	The name of the station
state	String	The state or region code that the station resides within.
lat	Float	Latitude in decimal format
lng	Float	Longitude in decimal format
timezone	String	The time zone name for the station.
timezonecorr	Integer	The time zone corr number for the station.
observedst	boolean	Whether or not the station uses Daylight saving time.
datums	class java.util.ArrayList	A unique URL to a list of datums applicable to the station.
epoch	String	The epoch used for each set of datums.
minor_on_stnd_datum	Float	The minor flood threshold on the station datum.
moderate_on_stnd_datum	Float	The moderate flood threshold on the station datum.
major_on_stnd_datum	Float	The major flood threshold on the station datum.
flood_count_start_date	String	The date the flood day counts started for each station.
flood_count_last_date	String	The last date the flood counts were calculated for each station.
longterm_projection_date	String	The date when the long-term annual and decadal projections were calculated.

Name	Type	Description
established	String	Date and time the station was installed.
removed	String	Date and time the station was removed, if applicable.
noaachart	String	NOAA Chart number
timemeridian	Integer	Time meridian
timezone	Float	Timezone offset from UTC
origyear	String	Date and time of the current installation.
self	String	A unique URL pointing to this resource

Name	Type	Description
units	String	Whether values returned are in 'feet' or 'meters'.
sensorList	Array	The collection of sensors at this station. Returns as a collection of <Sensor> elements in XML, or as an array titled 'sensors' in JSON.
self	String	A unique URL pointing to this resource

Name	Type	Description
status	Integer	1 if enabled, 0 if disabled.
refdatum	String	Referring datum, if applicable.
sensorID	String	An alphanumeric designation for the sensor type.
name	String	The descriptive name of the sensor.
elevation	Float	Elevation of the sensor, if applicable.
message	String	Quality control (CORMS) status message, if applicable.
dcp	Integer	The Data Collection Platform (DCP) number this sensor is associated with.

Name	Type	Description
nos_minor	Float	NOS Minor Flood Threshold.
nos_moderate	Float	NOS Moderate Flood Threshold.
nos_major	Float	NOS major Flood Threshold.
nws_minor	Float	NWS Minor Flood Threshold.
nws_moderate	Float	NWS Moderate Flood Threshold.
nws_major	Float	NWS major Flood Threshold.
action	Float	WL Action Level.
self	String	A unique URL pointing to this resource

Name	Type	Description
noticeList	Array	The collection of notices posted for this station. Returns as a collection of <Notice> elements in XML, or as an array titled 'notices' in JSON.
self	String	A unique URL pointing to this resource

Name	Type	Description
name	String	Name of the station notice.
text	String	Notice text.

Name	Type	Description
disclaimerList	Array	The collection of disclaimers at this station. Returns as a collection of <Disclaimer> elements in XML, or as an array titled 'disclaimers' in JSON.
self	String	A unique URL pointing to this resource

Name	Type	Description
name	String	Name of the disclaimer.
text	String	Text of the disclaimer.

Name	Type	Description
accepted	String	Date these datums were marked as accepted.
superseded	String	Date these datums were marked as superseded, if applicable.
epoch	String	The years valid for this set of datums.
units	String	Whether values returned are in 'feet' or 'meters'.
OrthometricDatum	String	The abbreviation of the datum marked as orthometric for this station.
datumList	Array	The collection of datums relevant to this station. Returns as a collection of <datum> elements in XML, or as an array titled 'datums' in JSON.
LAT	Float	Least Astronomical Tide
LATdate	String	Date that the Least Astronomical Tide was observed.
LATtime	String	Time that the Least Astronomical Tide was observed.
HAT	Float	Highest Astronomical Tide
HATdate	String	Date that the Highest Astronomical Tide was observed.
HATtime	String	Time that the Highest Astronomical Tide was observed.
min	Float	Lowest observed water level.
mindate	String	Date that the lowest observed water level was observed.
mintime	String	Time that the lowest observed water level was observed.
max	Float	Highest observed water level.
maxdate	String	Date that the highest observed water level was observed.
maxtime	String	Time that the lowest observed water level was observed.
disclaimers	class gov.noaa.nos.coops.api.disclaimers.DisclaimerCollection	Collection of disclaimer resources relevant to this station.
DatumAnalysisPeriod	Array	List of date ranges in which datum analysis was performed.
NGSLink	String	Link to NGS (National Geodetic Survey) stick plot for these datums.
ctrlStation	String	Control Station.
self	String	A unique URL pointing to this resource

Name	Type	Description
name	String	Datum name.
description	String	Datum description.
value	float	Datum value.

Name	Type	Description
units	String	Whether values returned are in feet or meters.
harconList	Array	The collection of harmonic constituents relevant to this station. Returns as a collection of <HarmonicConstituent> elements in XML, or as an array titled 'HarmonicConstituents' in JSON.
self	String	A unique URL pointing to this resource

Name	Type	Description
number	Integer	Constituent number.
name	String	Constituent name.
description	String	Constituent description.
amplitude	float	Amplitude in feet or meters.
phase_GMT	float	The phase lag of the observed tidal constituent relative to the theoretical equilibrium tide, in GMT
phase_local	float	The phase lag of the observed tidal constituent relative to the theoretical equilibrium tide, in local time.
speed	float	The rate change in the phase of a constituent, expressed in degrees per hour. The speed is equal to 360 degrees divided by the constituent period expressed in hours.

Name	Type	Description
binNbr	Integer	Bin number.
binDepth	Float	Bin Depth in feet or meters.
constNum	Integer	Constant number.
constituentName	String	Constituent Name.
description	String	Constituent description.
majorAmplitude	Float	Major Amplitude.
majorPhase	Float	Major Phase.
majorPhaseGMT	Float	Major Phase GMT.
minorAmplitude	Float	Minor Amplitude.
minorPhase	Float	Minor Phase.
minorPhaseGMT	Float	Minor Phase GMT.
majorMeanSpeed	Float	HA Major Mean Speed.
minorMeanSpeed	Float	MA Minor Mean Speed.
azi	Float	AZI.

Name	Type	Description
refStationId	String	reference station id
type	String	station type
heightOffsetHighTide	Float	Height offset for high tide.
heightOffsetLowTide	Float	Height offset for low tide.
timeOffsetHighTide	Integer	Time offset for high tide.
timeOffsetLowTide	Integer	Time offset for low tide.
heightAdjustedType	String	Type of height adjustment.
self	String	A unique URL pointing to a record of this resource.

Name	Type	Description
refStationId	String	Reference station ID (for subordinate stations only)
refStationBin	Integer	Reference station bin (for subordinate stations only)
meanFloodDir	Float	Mean flood direction (in deg true)
meanEbbDir	Float	Mean ebb direction (in deg true)
mfcTimeAdjMin	Integer	Max flood current time offset (in minutes from reference station event)
sbeTimeAdjMin	Integer	Slack before ebb time offset (in minutes from reference station event)
mecTimeAdjMin	Integer	Max ebb current time offset (in minutes from reference station event)
sbfTimeAdjMin	Integer	Slack before flood time offset (in minutes from reference station event)
mfcAmpAdj	Float	Max flood current speed ratio from reference station
mecAmpAdj	Float	Max ebb current speed ratio from reference station
self	String	A unique URL pointing to a record of these current prediction offsets

Name	Type	Description
nbr_of_bins	Integer	The number of bins returned.
max_pics_bin	Integer	For PORTS & Tides Online, which bin to plot up to.
units	String	Whether values returned are in 'feet' or 'meters'.
bin_size	Float	The size of a bin.
center_bin_1_dist	Float	Distance to the center of bin 1.
real_time_bin	Integer	Main bin used for observations and predictions for real-time applications such as PORTS, text and voice products.
binList	Array	The collection of bins at this station. Returns as a collection of <Bin> elements in XML, or as an array titled 'bins' in JSON.
self	String	A unique URL pointing to this resource

Name	Type	Description
num	Integer	Bin number.
depth	Float	Depth of bin. Only applicable if sensor orientation is up or down.
distance	Float	Distance of bin. Only applicable if sensor orientation is sideways.
qc_flag	Integer	Quality Control flag.
ping_int	Integer	The interval at which the bin is pinged.
is_pics	Boolean	Whether or not the bin is marked for dissemination in PORTS/Tides Online/Great Lakes Online

Name	Type	Description
benchmarkList	Array	The collection of benchmarks related to this station. Returns as a collection of <Benchmark> elements in XML, or as an array titled 'benchmarks' in JSON.
to_reach	String	Directions to the tidal benchmarks.
self	String	A unique URL pointing to this resource

Name	Type	Description
designation	String	Benchmark designation.
vm	Integer	Vertical mark number.
lat	Float	Latitude in decimal format.
lng	Float	Longitude in decimal format.
description	String	Description of the benchmark.
published	boolean	Whether or not the benchmark has been published.
stamping	String	Benchmark stamping.
alias	String	Benchmark alias.
dateEst	String	Benchmark establishment date.
agency	String	Benchmark agency.
monumentTypeId	String	Benchmark monument type ID.
monumentType	String	Benchmark monument type.
monumentTypeDescr	String	Benchmark monument type description.
settingClassId	String	Benchmark setting class ID.
settingClass	String	Benchmark setting class.
settingClassDescr	String	Benchmark setting class description.
opusPid	String	OPUS project ID.
idbPid	String	NGS IDB PID.
stationId	String	Station ID
vmDepth	Float	Benchmark depth.
monumentCond	String	Benchmark monument condition.
monumentCondDescr	String	Benchmark monument condition description.
verified	boolean	Indicate if this is a verified Benchmark.
display	boolean	A flag used to indicate if a benchmark should be displayed on the TAC map.
stateCode	String	State Code
elevation	Float	Elevation height
datums	class gov.noaa.nos.coops.api.datums.DatumCollection	The collection of datums relevant to this station. Returns as a collection of <datum> elements in XML, or as an array titled 'datums' in JSON.

Name	Type	Description
productList	Array	The collection of products. Returns as a collection of <Product> elements in XML, or as an array titled 'products' in JSON.
self	String	A unique URL pointing to this resource

Name	Type	Description
name	String	The name of the product.
value	String	The URL or pertinent information relating to the product.

Name	Type	Description
stationType	String	A comma separated list of data types this station supports, for filtering use.
distance	float	The distance in nautical miles from the queried station.
id	String	A unique alphanumeric ID specific to this station.
name	String	The name of the station
lat	Float	Latitude in decimal format
lng	Float	Longitude in decimal format

Name	Type	Description
units	String	Whether values returned are in 'feet' or 'meters'.
flood_direction_degrees	Float	Direction of flood in degrees.
orientation	String	Orientation of the sensor, 'up', 'down', or 'side'
sensor_depth	Float	Depth below the water surface in feet or meters at which the sensor was installed for downward looking and side looking instruments.
depth	Float	Estimated depth of the water column at the sensor location.
measured_depth	Float	Water depth (in feet or meters) determined statistically using instrument measured pressure data along with the height of the sensor above the seafloor.
height_from_bottom	Float	Height from bottom.
sample_interval	Integer	Sample interval, in seconds.
ping_int	Integer	Date and time of the beginning of quality data included in analysis
first_good_data	String	Ping int
last_good_data	String	Date and time of the end of quality data included in analysis.
deploymentList	Array	The collection of deployments at this station. Returns as a collection of <Deployment> elements in XML, or as an array titled 'deployments' in JSON.
self	String	A unique URL pointing to this resource

Name	Type	Description
deployed	String	When the deployment began.
retrieved	String	When the deployment ended, if applicable.
lat	Float	Latitude in decimal format.
lng	Float	Longitude in decimal format.
instrument_id	Integer	A unique number referencing the instrument in CO-OPS' database.
instrument_desc	String	Description of the sensor.
real_time_bin	Integer	The bin number marked for real-time dissemination.

Email: co-ops.userservices@noaa.gov

Introduction

Release Notes

Version 1.0 - First Major Production Release

Making a request

Request Components

id Station ID

resource Resource

.extension Output Formats

type Type

units Units

ports PORTS Code

expand Expand (optional)

Expand options per resource type

radius Radius (optional)

bin Bin (optional)

Examples

Resource Types

Stations

Station Collection

Water Level

Tide Prediction

Current

Current Prediction

High Tide Flooding

Details

Sensors

Sensor Collection

Sensor

Flood Levels

Notices

Notice Collection

Notice

Disclaimers

Disclaimer Collection

Disclaimer

Datums

Datum Collection

Datum

Harmonic Constituents

Harmonic Constituent Collection

Harmonic Constituent

Current Harmonic Constituent

Tide Prediction Offsets

Current Prediction Offsets

Bins

Bin Collection

Bin

Benchmarks

Benchmark Collection

Benchmark

Products

Product Collection

Product

Nearby

Current Station Deployments

Deployment Collection

Deployment

Contact Us