Introduction

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

Release Notes

Version 1.0 - First Major Production Release

** New Feature
    * [MDAPI-246] - Add NOS Flood Thresholds to MDAPI water level stations metadata

            
View previous release notes

Making a request

Requests to the metadata API are structured in one of the following ways:
A single station record:
http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/id.extension
http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/9414290.json
http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/id/resource.extension
http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/1611400/datums.json
Multiple station records:
http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations.extension
http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations.xml
http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations.extension?type=type
http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations.json?type=currents

Request Components

There are several components that make up a request.

id Station ID

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

resource Resource

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

Non-Current meter stations
OptionDescription
datumsWater level datums. A datum is a base elevation used as a reference from which to reckon heights or depths.
supersededdatumsSuperseded water level datums. Datums from the previous epoch.
harconHarmonic constituents used for tide predictions.
sensorsInstalled observing sensors at a station, including status and any messages related to an outage.
detailsInstallation date, removal date, and other details about a station.
noticesStation specific notices.
disclaimersDisclaimers relevant to this station.
benchmarksFixed physical objects or marks used as a reference for a horizontal or vertical datum.
tidepredoffsetsOffsets used in the calculation of tidal predictions.
floodlevelsNOS and NWS flood thresholds.
Current meter stations
OptionDescription
noticesStation specific notices.
disclaimersDisclaimers relevant to this station.
binsDiscrete depths at which data are collected.
deploymentsPeriods at which an instrument is collecting data at a given location.
Tide Prediction stations
OptionDescription
tidepredoffsetsOffsets used in the calculation of tidal predictions.
Current Prediction stations
OptionDescription
currentpredictionoffsetsOffsets used in the calculation of tidal current predictions.
"Benchmarks" resource with format set to JSON.
      Excerpt from http://tidesandcurrents.noaa.gov/mdapi/v1.0/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
            },
      ...

.extension Output Formats

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 OptionHeader OptionDescription
.jsonapplication/jsonJSON (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
.xmlapplication/xmlExtensible 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 http://tidesandcurrents.noaa.gov/mdapi/v1.0/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="http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/1611400.xml">
         <id>1611400</id>
         <name>Nawiliwili</name>
         <lat>21.954506</lat>
         <lng>-159.3561</lng>
      ...

type Type

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
OptionDescription
waterlevelsStations that actively measure water levels
historicwlStations that have measured water levels in the past. This includes active stations.
metStations that have one or more meteorological sensors installed, such as air temperature.
waterlevelsandmetCombined results of waterlevels and met types. Results in a list of active stations, excluding current meters.
tidepredictionsStations that offer tide predictions based on harmonic analysis.
harconWater level stations with measured harmonic constituents.
datumsWater level stations with datums.
supersededdatumsWater level stations with superseded datums.
benchmarksWater level stations with published benchmarks.
supersededbenchmarksWater level stations with superseded benchmarks.
currentsReal-time current meter stations that are presently deployed and are actively measuring currents.
historiccurrentsCurrent meter stations that are no longer deployed, such as historic real-time stations that have been uninstalled or short-term survey stations.
surveycurrentsShort-term current meter stations that collected data for a limited time in order improve tidal current predictions or support operational forecast models.
currentpredictionsCurrent meter stations for which tidal current predictions are available.
condStations that have conductivity sensors installed.
watertempStations that have water temperature sensors installed.
physoceanStations that have a physical oceanography(water temperature/conductivity) sensor installed.
tcoonStations that are affiliated with the Texas Coastal Ocean Observation Network (TCOON).
1minuteStations that have 1 minute water level data.
airgapStations that have air gap data.
"Stations" resource with type set to 'waterlevels'
      Excerpt from http://tidesandcurrents.noaa.gov/mdapi/v1.0/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": "http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/1611400/details.json"
            },
      ...

units Units

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

Unit Options
OptionDescription
englishFeet
metricMeters
"Bins" resource of station 'cb0102' with units set to 'metric'. Affected fields are highlighted in red.
      Excerpt from http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/cb0102/bins.json?units=metric
      ...
      "self": "http://http://tidesandcurrents.noaa.gov/mdapi/v1.0/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
         },
      ...

expand Expand (optional)

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 http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/1611400.json
      ...
      "details": {
        "self": "http://tidesandcurrents.noaa.gov/mdapi/v1.0/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 http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/1611400.json?expand=details
      ...
      "details": {
      "self": "http://tidesandcurrents.noaa.gov/mdapi/v1.0/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 http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/1611400.json?expand=details,sensors
      ...
      "details": {
        "self": "http://tidesandcurrents.noaa.gov/mdapi/v1.0/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": "http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/1611400/sensors.json",
        "sensorList": [
          {
            "status": 1,
            "refdatum": "",
            "sensorID": "A1",
            "name": "",
            "message": "",
            "dcp": 1
          },
      ...
            

Expand options per resource type

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

radius Radius (optional)

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

Radius
OptionDescription
Any positive numberDistance in nautical miles to return nearby stations from.

"Nearby" resource with "radius=3" appended to request for a station record:
      Excerpt from http://tidesandcurrents.noaa.gov/mdapi/v1.0/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": "http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/9414769.json"
         },
      ...
            


Examples

Basic requests
RequestLink
Active water level stations in XML http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations.xml?type=waterlevels
Active current meter stations in JSON http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations.json?type=currents
Station details for 9414290, San Francisco CA in XML http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/9414290/details.xml
Benchmarks for 1611400, Nawiliwili, HI in JSON http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/1611400/benchmarks.json
Advanced requests
RequestLink
Water level station 9414290, San Francisco CA with station details and sensors included, with metric units, in JSON http://tidesandcurrents.noaa.gov/mdapi/v1.0/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 http://tidesandcurrents.noaa.gov/mdapi/v1.0/webapi/stations/cb0102.json?expand=deployments&units=english

Resource Types

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

Stations

Stations can be one of four types: Water Level, Tide Prediction, Current, or Current Prediction.

Station Collection

The following fields are returned as part of a Stations request.
NameTypeDescription
countIntegerThe number of stations returned for the request.
stationListArrayThe collection of stations. Returns as a collection of <Station> elements in XML, or as an array titled 'stations' in JSON.
selfStringA unique URL pointing to this resource

Each station record returned within the Station Collection will contain the following fields, dependent on type.

Water Level

NameTypeDescription
tidalbooleanWhether or not the station is tidal.
greatlakesbooleanWhether or not the station is in the Great Lakes region.
shefcodeStringSHEF code for NWS reference.
detailsURLA unique URL to a list of details about the station.
sensorsURLA unique URL to a list of sensors configured at the station.
floodlevelsURLA unique URL to a list of flood levels configured at the station.
datumsURLA unique URL to a list of datums applicable to the station.
supersededdatumsURLA unique URL to a list of supersededdatums applicable to the station.
harmonicConstituentsURLHarmonic constituents for tidal prediction.
benchmarksURLA unique URL to a list of benchmarks applicable to the station.
tidePredOffsetsURLTide prediction offsets
stateStringThe state or region code that the station resides within.
timezoneStringThe time zone name for the station.
timezonecorrIntegerThe time zone corr number for the station.
observedstbooleanWhether or not the station uses Daylight saving time.
stormsurgeBooleanWhether or not the station is in storm surge mode.
nearbyURLA unique URL to a list of nearby stations.
idStringA unique alphanumeric ID specific to this station.
nameStringThe name of the station
latFloatLatitude in decimal format
lngFloatLongitude in decimal format
affiliationsStringA comma separated list of programs or partnerships the station is affiliated with
portscodeStringA two character code indicating the station is a member of a Physical Oceanographic Real-Time System (PORTS)
productsURLA unique URL to a list of name/URL pairs for web products offered by CO-OPS
disclaimersURLA unique URL to a list of disclaimers relevant to the station.
noticesURLA unique URL to a list of station-specific notices.
selfStringA unique URL pointing to a record of the station
expandStringA comma separated list of values valid for expansion (see expansion).
tideTypeStringStation Tide Type.

Tide Prediction

NameTypeDescription
stateStringThe state or region code that the station resides within.
tidepredoffsetsURLA unique URL referencing tide prediction offsets for this station.
typeStringR for reference stations, S for subordinate stations.
timemeridianIntegerTime meridian
reference_idStringA unique alphanumeric ID referencing a subordinate station's reference station, if applicable
timezonecorrIntegerThe time zone corr number for the station.
idStringA unique alphanumeric ID specific to this station.
nameStringThe name of the station
latFloatLatitude in decimal format
lngFloatLongitude in decimal format
affiliationsStringA comma separated list of programs or partnerships the station is affiliated with
portscodeStringA two character code indicating the station is a member of a Physical Oceanographic Real-Time System (PORTS)
productsURLA unique URL to a list of name/URL pairs for web products offered by CO-OPS
disclaimersURLA unique URL to a list of disclaimers relevant to the station.
noticesURLA unique URL to a list of station-specific notices.
selfStringA unique URL pointing to a record of the station
expandStringA comma separated list of values valid for expansion (see expansion).
tideTypeStringStation Tide Type.

Current

NameTypeDescription
projectStringProject the station is associated with.
deployedStringWhen the station was deployed.
retrievedStringWhen the station was retrieved, if applicable.
timezone_offsetStringTimezone offset.
observedstbooleanProject type, either 'PORTS' or 'Survey'
project_typeStringwhether this station observes Daylight Saving Time
noaachartIntegerNOAA Chart#
deploymentsURLA unique URL to a list of deployments.
binsURLA unique URL to a list of bins.
idStringA unique alphanumeric ID specific to this station.
nameStringThe name of the station
latFloatLatitude in decimal format
lngFloatLongitude in decimal format
affiliationsStringA comma separated list of programs or partnerships the station is affiliated with
portscodeStringA two character code indicating the station is a member of a Physical Oceanographic Real-Time System (PORTS)
productsURLA unique URL to a list of name/URL pairs for web products offered by CO-OPS
disclaimersURLA unique URL to a list of disclaimers relevant to the station.
noticesURLA unique URL to a list of station-specific notices.
selfStringA unique URL pointing to a record of the station
expandStringA comma separated list of values valid for expansion (see expansion).
tideTypeStringStation Tide Type.

Current Prediction

NameTypeDescription
currentpredictionoffsetsBooleanA unique URL to a list of current prediction offsets applicable to the station.
currbinIntegerThe bin number selected for use in tidal current predictions.
typeStringCurrent prediction classification (H=harmonic, S=subordinate, W=weak and variable)
depthFloatDepth of predictions (in feet)
depthTypeStringDepth measurement type ('U' = Unknown, 'B' = below chart datum, 'S' = below surface)
idStringA unique alphanumeric ID specific to this station.
nameStringThe name of the station
latFloatLatitude in decimal format
lngFloatLongitude in decimal format
affiliationsStringA comma separated list of programs or partnerships the station is affiliated with
portscodeStringA two character code indicating the station is a member of a Physical Oceanographic Real-Time System (PORTS)
productsURLA unique URL to a list of name/URL pairs for web products offered by CO-OPS
disclaimersURLA unique URL to a list of disclaimers relevant to the station.
noticesURLA unique URL to a list of station-specific notices.
selfStringA unique URL pointing to a record of the station
expandStringA comma separated list of values valid for expansion (see expansion).
tideTypeStringStation Tide Type.

Details

NameTypeDescription
establishedStringDate and time the station was installed.
removedStringDate and time the station was removed, if applicable.
noaachartStringNOAA Chart number
timemeridianIntegerTime meridian
timezoneFloatTimezone offset from UTC
origyearStringDate and time of the current installation.
selfStringA unique URL pointing to this resource

Sensors

Sensor Collection

The following fields are returned as part of a Sensors request.
NameTypeDescription
unitsStringWhether values returned are in 'feet' or 'meters'.
sensorListArrayThe collection of sensors at this station. Returns as a collection of <Sensor> elements in XML, or as an array titled 'sensors' in JSON.
selfStringA unique URL pointing to this resource

Sensor

The fields for each sensor returned as part of a Sensors request are described below.
NameTypeDescription
statusInteger1 if enabled, 0 if disabled.
refdatumStringReferring datum, if applicable.
sensorIDStringAn alphanumeric designation for the sensor type.
nameStringThe descriptive name of the sensor.
elevationFloatElevation of the sensor, if applicable.
messageStringQuality control (CORMS) status message, if applicable.
dcpIntegerThe Data Collection Platform (DCP) number this sensor is associated with.

Flood Levels

NameTypeDescription
nos_minorFloatNOS Minor Flood Threshold.
nos_moderateFloatNOS Moderate Flood Threshold.
nos_majorFloatNOS major Flood Threshold.
nws_minorFloatNWS Minor Flood Threshold.
nws_moderateFloatNWS Moderate Flood Threshold.
nws_majorFloatNWS major Flood Threshold.
actionFloatWL Action Level.
selfStringA unique URL pointing to this resource

Notices

Notice Collection

The following fields are returned as part of a Notices request.
NameTypeDescription
noticeListArrayThe collection of notices posted for this station. Returns as a collection of <Notice> elements in XML, or as an array titled 'notices' in JSON.
selfStringA unique URL pointing to this resource

Notice

The fields for each notice returned as part of a Notices request are described below.
NameTypeDescription
nameStringName of the station notice.
textStringNotice text.

Disclaimers

Disclaimer Collection

The following fields are returned as part of a Disclaimers request.
NameTypeDescription
disclaimerListArrayThe collection of disclaimers at this station. Returns as a collection of <Disclaimer> elements in XML, or as an array titled 'disclaimers' in JSON.
selfStringA unique URL pointing to this resource

Disclaimer

The fields for each disclaimer returned as part of a Disclaimers request are described below.
NameTypeDescription
nameStringName of the disclaimer.
textStringText of the disclaimer.

Datums

Datum Collection

The following fields are returned as part of a Datums request.
NameTypeDescription
acceptedStringDate these datums were marked as accepted.
supersededStringDate these datums were marked as superseded, if applicable.
epochStringThe years valid for this set of datums.
unitsStringWhether values returned are in 'feet' or 'meters'.
OrthometricDatumStringThe abbreviation of the datum marked as orthometric for this station.
datumListArrayThe collection of datums relevant to this station. Returns as a collection of <datum> elements in XML, or as an array titled 'datums' in JSON.
LATFloatLeast Astronomical Tide
LATdateStringDate that the Least Astronomical Tide was observed.
LATtimeStringTime that the Least Astronomical Tide was observed.
HATFloatHighest Astronomical Tide
HATdateStringDate that the Highest Astronomical Tide was observed.
HATtimeStringTime that the Highest Astronomical Tide was observed.
minFloatLowest observed water level.
mindateStringDate that the lowest observed water level was observed.
mintimeStringTime that the lowest observed water level was observed.
maxFloatHighest observed water level.
maxdateStringDate that the highest observed water level was observed.
maxtimeStringTime that the lowest observed water level was observed.
disclaimersclass gov.noaa.nos.coops.api.disclaimers.DisclaimerCollectionCollection of disclaimer resources relevant to this station.
DatumAnalysisPeriodArrayList of date ranges in which datum analysis was performed.
NGSLinkStringLink to NGS (National Geodetic Survey) stick plot for these datums.
ctrlStationStringControl Station.
selfStringA unique URL pointing to this resource

Datum

The fields for each datum returned as part of a Datum Collection request are described below.
NameTypeDescription
nameStringDatum name.
descriptionStringDatum description.
valuefloatDatum value.

Harmonic Constituents

Harmonic Constituent Collection

The following fields are returned as part of a Harmonic Constituents request.
NameTypeDescription
unitsStringWhether values returned are in feet or meters.
harconListArrayThe 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.
selfStringA unique URL pointing to this resource

Harmonic Constituent

The fields for each harmonic constituent returned as part of a Harmonic Constituents request are described below.
NameTypeDescription
numberIntegerConstituent number.
nameStringConstituent name.
descriptionStringConstituent description.
amplitudefloatAmplitude in feet or meters.
phase_GMTfloatThe phase lag of the observed tidal constituent relative to the theoretical equilibrium tide, in GMT
phase_localfloatThe phase lag of the observed tidal constituent relative to the theoretical equilibrium tide, in local time.
speedfloatThe 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.

Tide Prediction Offsets

NameTypeDescription
refStationIdStringreference station id
typeStringstation type
heightOffsetHighTideFloatHeight offset for high tide.
heightOffsetLowTideFloatHeight offset for low tide.
timeOffsetHighTideIntegerTime offset for high tide.
timeOffsetLowTideIntegerTime offset for low tide.
heightAdjustedTypeStringType of height adjustment.
selfStringA unique URL pointing to a record of this resource.

Current Prediction Offsets

NameTypeDescription
refStationIdStringReference station ID (for subordinate stations only)
refStationBinIntegerReference station bin (for subordinate stations only)
meanFloodDirFloatMean flood direction (in deg true)
meanEbbDirFloatMean ebb direction (in deg true)
mfcTimeAdjMinIntegerMax flood current time offset (in minutes from reference station event)
sbeTimeAdjMinIntegerSlack before ebb time offset (in minutes from reference station event)
mecTimeAdjMinIntegerMax ebb current time offset (in minutes from reference station event)
sbfTimeAdjMinIntegerSlack before flood time offset (in minutes from reference station event)
mfcAmpAdjFloatMax flood current speed ratio from reference station
mecAmpAdjFloatMax ebb current speed ratio from reference station
selfStringA unique URL pointing to a record of these current prediction offsets

Bins

Bin Collection

The following fields are returned as part of a Bins request.
NameTypeDescription
nbr_of_binsIntegerThe number of bins returned.
max_pics_binIntegerFor PORTS & Tides Online, which bin to plot up to.
unitsStringWhether values returned are in 'feet' or 'meters'.
bin_sizeFloatThe size of a bin.
center_bin_1_distFloatDistance to the center of bin 1.
real_time_binIntegerMain bin used for observations and predictions for real-time applications such as PORTS, text and voice products.
binListArrayThe collection of bins at this station. Returns as a collection of <Bin> elements in XML, or as an array titled 'bins' in JSON.
selfStringA unique URL pointing to this resource

Bin

The fields for each bin returned as part of a Bins request are described below.
NameTypeDescription
numIntegerBin number.
depthFloatDepth of bin. Only applicable if sensor orientation is up or down.
distanceFloatDistance of bin. Only applicable if sensor orientation is sideways.
qc_flagIntegerQuality Control flag.
ping_intIntegerThe interval at which the bin is pinged.
is_picsBooleanWhether or not the bin is marked for dissemination in PORTS/Tides Online/Great Lakes Online

Benchmarks

Benchmark Collection

The following fields are returned as part of a Benchmarks request.
NameTypeDescription
benchmarkListArrayThe 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_reachStringDirections to the tidal benchmarks.
selfStringA unique URL pointing to this resource

Benchmark

The fields for each benchmark returned as part of a Benchmarks request are described below.
NameTypeDescription
designationStringBenchmark designation.
vmIntegerVertical mark number.
latFloatLatitude in decimal format.
lngFloatLongitude in decimal format.
descriptionStringDescription of the benchmark.
publishedbooleanWhether or not the benchmark has been published.
aliasStringBenchmark stamping.
dateEstStringBenchmark alias.
agencyStringBenchmark establishment date.
monumentTypeIdStringBenchmark agency.
monumentTypeStringBenchmark monument type ID.
monumentTypeDescrStringBenchmark monument type.
settingClassIdStringBenchmark monument type description.
settingClassStringBenchmark setting class ID.
settingClassDescrStringBenchmark setting class.
opusPidStringBenchmark setting class description.
idbPidStringOPUS project ID.
vmDepthFloatNGS IDB PID.
monumentCondStringBenchmark depth.
monumentCondDescrStringBenchmark monument condition.
verifiedbooleanBenchmark monument condition description.

Products

Product Collection

The following fields are returned as part of a Products request.
NameTypeDescription
productListArrayThe collection of products. Returns as a collection of <Product> elements in XML, or as an array titled 'products' in JSON.
selfStringA unique URL pointing to this resource

Product

The fields for each product returned as part of a Products request are described below.
NameTypeDescription
nameStringThe name of the product.
valueStringThe URL or pertinent information relating to the product.

Nearby

NameTypeDescription
stationTypeStringA comma separated list of data types this station supports, for filtering use.
distancefloatThe distance in nautical miles from the queried station.
idStringA unique alphanumeric ID specific to this station.
nameStringThe name of the station
latFloatLatitude in decimal format
lngFloatLongitude in decimal format

Current Station Deployments

Deployment Collection

The following fields are returned as part of a Deployments request.
NameTypeDescription
unitsStringWhether values returned are in 'feet' or 'meters'.
flood_direction_degreesFloatDirection of flood in degrees.
orientationStringOrientation of the sensor, 'up', 'down', or 'side'
sensor_depthFloatDepth below the water surface in feet or meters at which the sensor was installed for downward looking and side looking instruments.
depthFloatEstimated depth of the water column at the sensor location.
measured_depthFloatWater depth (in feet or meters) determined statistically using instrument measured pressure data along with the height of the sensor above the seafloor.
height_from_bottomFloatHeight from bottom.
sample_intervalIntegerSample interval, in seconds.
ping_intIntegerDate and time of the beginning of quality data included in analysis
first_good_dataStringPing int
last_good_dataStringDate and time of the end of quality data included in analysis.
deploymentListArrayThe collection of deployments at this station. Returns as a collection of <Deployment> elements in XML, or as an array titled 'deployments' in JSON.
selfStringA unique URL pointing to this resource

Deployment

The fields for each deployment returned as part of a Deployments request are described below.
NameTypeDescription
deployedStringWhen the deployment began.
retrievedStringWhen the deployment ended, if applicable.
latFloatLatitude in decimal format.
lngFloatLongitude in decimal format.
instrument_idIntegerA unique number referencing the instrument in CO-OPS' database.
instrument_descStringDescription of the sensor.
real_time_binIntegerThe bin number marked for real-time dissemination.

Contact Us