NOAA Tides And Currents

🚀 NOAA Tides and Currents API Documentation

This API documentation provides a comprehensive guide to using the NOAA Tides and Currents API, which offers access to a wide range of oceanographic data, including tide predictions, current data, and astronomical event information.

🚀 Quick Start

Base URLs

• CO - OPS Data API: https://api.tidesandcurrents.noaa.gov/api/prod/
• CO - OPS Metadata API: https://api.tidesandcurrents.noaa.gov/mdapi/prod/
• CO - OPS Derived Products API: https://api.tidesandcurrents.noaa.gov/dpapi/prod/

Request Method

All requests must use the GET method.

Response Formats

The API supports the following response formats:

1. JSON: Suitable for most queries.
2. XML: Ideal for requests requiring specific data structures.
3. CSV: Useful for data export and batch processing.

Example Requests

Get Tide Predictions

https://api.tidesandcurrents.noaa.gov/api/prod/tidepredictions?station=8537062

Get Current Data

https://api.tidesandcurrents.noaa.gov/api/prod/currents?station=9410160

Return Parameters

• status: Request status (success or failure).
• message: Detailed error information (only returned on failure).
• data: Data from the query result.

✨ Features

Tides and Currents Data Query

Get Tide Predictions

async function getTidePredictions(stationId) {
    const response = await fetch(`https://api.tidesandcurrents.noaa.gov/api/prod/tidepredictions?station=${stationId}`);
    return await response.json();
}

Get Historical Current Data

async function getHistoricalCurrents(stationId, date) {
    const response = await fetch(`https://api.tidesandcurrents.noaa.gov/api/prod/currents/historical?station=${stationId}&date=${date}`);
    return await response.json();
}

Derived Products API

Get Tides and Currents Alerts

async function getWarnings(warningType) {
    const response = await fetch(`https://api.tidesandcurrents.noaa.gov/dpapi/prod/alerts?type=${warningType}`);
    return await response.json();
}

Metadata API

Get Station Information

async function getStationInfo(stationId) {
    const response = await fetch(`https://api.tidesandcurrents.noaa.gov/mdapi/prod/stations/${stationId}`);
    return await response.json();
}

Astronomical Event Query

Moon Phase Information

Get Current Moon Phase

async function getCurrentMoonPhase() {
    const response = await fetch('https://api.tidesandcurrents.noaa.gov/moon/currentphase');
    return await response.json();
}

Get Next Moon Phases

async function getNextMoonPhases(count) {
    const response = await fetch(`https://api.tidesandcurrents.noaa.gov/moon/nextphases?count=${count}`);
    return await response.json();
}

Sun Position and Time

Get Sunrise and Sunset Times

async function getSunriseSunset(latitude, longitude) {
    const response = await fetch(`https://api.tidesandcurrents.noaa.gov/sun?lat=${latitude}&lon=${longitude}`);
    return await response.json();
}

🔧 Technical Details

FastMCP Framework

FastMCP is a framework for developing efficient and scalable ocean current and tide monitoring systems. It provides a series of tools and services to help developers quickly build and deploy related applications.

Key Features

Data Collection and Processing

• Supports access to multiple data sources.
• Provides real - time data processing capabilities.

Visualization Interface

• Automatically generates interactive charts and maps.
• Offers multi - dimensional data presentation.

Extension Plugin System

• Supports custom plugin development.
• Provides rich community plugin resources.

📦 Installation

Installation and Configuration

npm install fastmcp

Create a Basic Application

const FastMCP = require('fastmcp');

const app = new FastMCP({
    port: 3000,
    plugins: ['dataCollector', 'visualizer']
});

app.start().then(() => {
    console.log('Application started on port 3000');
});

Development Guide

Data Processing

app.use('dataProcessor', (data, next) => {
    // Process data
    next();
});

💻 Usage Examples

Get Real - Time Current Data

async function fetchCurrents() {
    const response = await fetch('https://api.tidesandcurrents.noaa.gov/api/prod/currents');
    return await response.json();
}

Handle the Response

fetchCurrents().then(data => {
    console.log(data);
});

📚 Documentation

Frequently Asked Questions

How to Handle API Errors?

• Check the returned status code.
• View detailed error information.

Performance Optimization Suggestions

• Use a caching mechanism.
• Limit the request frequency.

Supported Browsers

• Chrome
• Firefox
• Safari
• Edge

Contribution Guide

How to Submit an Issue?

• Submit it to GitHub Issues.

How to Contribute Code?

• Fork the repository.
• Submit a Pull Request.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for specific details.

Thank you for using the NOAA Tides and Currents API! For more information, please visit our official website or refer to the detailed developer documentation.